rfc120.txt

RFC 的详细文档！

          'cmpcd' is the completion code variable to be associated with
               the local socket
          'lclsck' is set to the socket identifier of the local socket
               if the completion code variable is associated with a
               socket, or to zero otherwise.

(7)  SIGNAL

     This operation is used to convey a signal to the  foreign  process.
     The  significance  of the signal is completely user-dependent.  The
     effect is that  the  next  time  the  foreign  socket  attempts  to
     initiate  a  RECEIVE  or  SEND  operation,  the  operation  will be
     suppressed, and a completion code supplied indicating that a signal
     had  been  received.  The subprogram will wait until the signal has



                                                               [Page 11]

RFC 120                 NETWORK PL1 SUBPROGRAMS


     been sent to the foreign NCP.  This operation is  valid  only  when
     the socket is fully open.

     The calling sequence is as follows:

          CALL @ID(cmpcd,time);

     where

          'cmpcd' is the completion code variable associated with the
               local socket.
          'time' is the length of time the subprogram is to wait for
               completion of the operation.

     The following completion codes are possible for this operation:

          0,  The operation was successful, and the signal has been sent
          4,  The specified completion code variable is not assigned to
              a socket;  the operation was suppressed
          8,  The connection is not fully open; the operation was
              suppressed

   Certain of the Network subprograms are  intended  for,  although  not
   restricted  to,  use  with the On-Line System Network operators.  The
   following is a general description of these operators:

   In all  Network  operations  involving  the  On-Line  System  Network
   operators, there are certain conventions concerning the format of the
   data sent and received.  The data is grouped in 'messages' consisting
   of  three  fields,  op code, length, and text, in that order.  The op
   code is one byte in length and is a code which indicates how the text
   field  is to be interpreted.  The length field is two bytes long, and
   gives the length, in bits, of the  text  field,  which  contains  the
   actual  data.   (The  op code and length fields together are termed a
   header.)

   The following op codes are presently defined:

     op code        meaning

        0     The op code is a NOP.  No text field exists, and the
              contents of the length field are unpredictable.  (This op
              code is used mainly as a delimiter.)

        1     The text field contains EBCDIC characters, one character
              per byte.  The On-Line System Network operators consider
              the characters as intended for display as soon as the
              text field has been received.



                                                               [Page 12]

RFC 120                 NETWORK PL1 SUBPROGRAMS


        2     The text contains codes for keypushes, one byte per key.
              The On-Line operators consider the text as intended for
              execution as soon as the text field has been received.

        3     The same as for an op code of 2, except that the On-Line
              operators consider that the execution of the keys will be
              delayed until all data for that receive operation has
              been received.

   The standard format of data sent or received by  the  On-Line  System
   operators is a string of messages, with the last message indicated by
   a header with a NOP op code, called a trailer.  These conventions are
   the  default  situation; any of them may be overridden by appropriate
   programming.

   Following are descriptions of those subprograms intended for use with
   the On-Line System operators.

(8)  WRITE TO ON-LINE CONSOLE

     This subprogram causes data, assumed to be  characters  represented
     by  their EBCDIC codes, to be sent from the specified local socket.
     The characters are sent  in  a  standard  message,  preceded  by  a
     header, and optionally followed by a trailer.  The subprogram waits
     for the data to be received by the foreign socket, or to be  queued
     locally  by  the  NCP.  This operation is valid only when the local
     socket is a send socket, and is fully open.

     The calling sequence is as follows:

          CALL @WTOLC(cmpcd,bfr,len,level,across,down,time);

     where

          'cmpcd' is the completion code variable associated with the
               local socket.
          'bfr' is the character string to be sent, and must have the
               attribute STRING, either CHARACTER or BIT, of any length,
               fixed or varying.
          'len', in absolute value, is the number of characters to be
               sent.  If 'len' is positive or zero, the end of the data
               is indicated by a trailer;  if 'len' is negative, no
               trailer is sent.  'len' has the attributes BINARY
               FIXED(31,0).
          'level' indicates the mode of typing.  The absolute value of
               'level', if non-zero, is the shift level on which to
               type, and must be less than or equal to nine.  If greater
               than nine, one is used.  If 'level' is positive, 'across'



                                                               [Page 13]

RFC 120                 NETWORK PL1 SUBPROGRAMS


               and down are relative to the current typing location.  If
               'level' is negative, the carriage is positioned to the
               upper left-hand corner before typing begins, thus making
               'across' and 'down' absolute coordinates.  If 'level' is
               zero, the typing is in case one characters, and a
               carriage return precedes the positioning for 'across' and
               'down'.  If the characters to be displayed are case one
               characters, the header sent will have an op code which
               indicates characters to be displayed as soon as they are
               received;  otherwise, the op code will indicate buttons
               to be executed as soon as received.  'level' has the
               attributes BINARY FIXED(31,0).
          'across' is the number of spaces to be moved horizontally
               across the display tube before beginning to type.
               'across' can have any value, positive, negative, or zero,
               and has the attributes BINARY FIXED(31,0).
          'down' is the number of lines to be moved vertically down the
               display tube before beginning to type.  'down' can have
               any value, positive, negative, or zero, and has the
               attributes BINARY FIXED(31,0).
          'time' is the length of time the subprogram is to wait for the
               completion of the operation.

     The completion codes for this operation are the same as for SEND.

(9)  READ FROM ON-LINE CONSOLE

     This subprogram receives data, assumed to be characters represented
     by  their  EBCDIC  codes,  from  the  foreign socket in one or more
     standard  messages.   The  subprogram  will  wait  for  the   data,
     optionally  followed  by  a  trailer,  to  be received by the local
     socket.  This operation is valid only when the local  socket  is  a
     receive socket and is fully open.

     The calling sequence is as follows:

          CALL @RFOLC(cmpcd,bfr,len,time);

     where

          'cmpcd' is the completion code variable associated with the
               local socket.
          'bfr' is the variable into which the data is to be placed, and
               has the attribute CHARACTER, of any fixed length.  If the
               length of 'bfr' is greater than the amount of data
               received, 'bfr' will be padded to the right with blanks.
          'len', in absolute value, is the maximum number of characters
               to be placed in 'bfr'.  If the length fields of the



                                                               [Page 14]

RFC 120                 NETWORK PL1 SUBPROGRAMS


               header(s) received total more data than 'len', the excess
               data will be received, but will not be placed into 'bfr',
               and will not be accessible to the program.  If 'len' is
               positive or zero, data will be received until a trailer
               is encountered.  If 'len' is negative, a single message,
               exclusive of trailer, will be received.  'len' has the
               attributes BINARY FIXED(31,0).
          'time' is the length of time the subprogram is to wait for the
               completion of the operation.

     The completion codes  for  this  operation  are  the  same  as  for
     RECEIVE.

(10)  WRITE TO ON-LINE CONSOLE WITH REPLY

     This  subprogram  combines  the  functions  of  'WRITE  TO  ON-LINE
     CONSOLE'  and  'READ  FROM  ON-LINE CONSOLE'.  The subprogram first
     sends a string of data to the foreign  socket  from  the  specified
     send  socket, waits for it to be received by the foreign socket (or
     queued locally by the NCP), and then waits  for  a  reply  directed
     toward  the  specified receive socket.  The operation is valid only
     when the sockets have the correct gender and both are fully open.

     The calling sequence is as follows:

          CALL @WTOLCR(cmpcd, bfr, len, level, across, down, time,
                       cmpcd2, bfr2, len2);

     where

          'cmpcd' is the completion code variable associated with the
               local send socket.
          'bfr' is as in 'WRITE TO ON-LINE CONSOLE'.
          'len' is as in 'WRITE TO ON-LINE CONSOLE'.
          'level' is as in 'WRITE TO ON-LINE CONSOLE'.
          'across' is as in 'WRITE TO ON-LINE CONSOLE'.
          'down' is as in 'WRITE TO ON-LINE CONSOLE'.
          'time' is the length of time the subprogram is to wait for
               completion, individually, of the transmission and
               reception of data.
          'cmpcd2' is the completion code variable associated with the
               local receive socket.
          'bfr2' is as 'bfr' in 'READ FROM ON-LINE CONSOLE'.
          'len2' is as 'len' in 'READ FROM ON-LINE CONSOLE'.

     The completion codes for the send socket are the same  as  for  the
     SEND operation, and the completion codes for the receive socket are
     the same as for the RECEIVE operation.



                                                               [Page 15]

RFC 120                 NETWORK PL1 SUBPROGRAMS


(11)  ERASE

      This subprogram causes data constituting an On-Line System command
      to  erase  the  display  tube  to be sent from the specified local
      socket.  The data is sent in a single standard message,  including
      an  op  code  indicating  characters  to  be displayed as they are
      received, and optionally  including  a  trailer.   The  subprogram
      waits  for the data to be received by the foreign socket, or to be
      queued locally by the NCP.  This operation is valid only when  the
      local socket is a send socket, and is fully open.

      The calling sequence is as follows:

           CALL @ERASE(cmpcd,delay1,delay2,time);

      where

           'cmpcd' is the completion code variable associated with the
                local socket.
           'delay1', in absolute value, is the length of time, in tenths
                of a second, the subprogram is to pause (in the WAIT
                state) before sending the erase.  If 'delay1' is
                positive or zero, a trailer will be sent after the
                erase;  if negative, no trailer will be sent.  'delay1'
                has the attributes BINARY FIXED(31,0).
           'delay2', is the length of time, in tenths of a second, the
                subprogram is to pause after sending the erase and
                before returning control to the calling program, and has
                the attributes BINARY FIXED(31,0).
           'time' is the length of time the subprogram is to wait for
                the completion of the operation.

      The completion codes for this operation are the same as for SEND.


          [ This RFC was put into machine readable form for entry ]
           [ into the online RFC archives by Rune Skaarsmoen 6/97 ]














                                                               [Page 16]