timod(7)                                                           timod(7)

NAME
     timod - Transport Interface cooperating STREAMS module

DESCRIPTION
     timod is a STREAMS module for use with the Transport Interface (TI)
     functions of the Network Services library. The timod module converts a
     set of ioctl(2) calls into STREAMS messages that may be consumed by a
     transport protocol provider which supports the Transport Interface.
     This allows a user to initiate certain TI functions as atomic opera-
     tions.

     The timod module must only be pushed onto a stream terminated by a
     transport protocol provider which supports the TI.

     All STREAMS messages, with the exception of the message types gen-
     erated from the ioctl commands described below, will be transparently
     passed to the neighboring STREAMS module or driver. The messages gen-
     erated from the following ioctl commands are recognized and processed
     by the timod module. The format of the ioctl call is:

          #include <sys/stropts.h>
                    -
                    -
          struct strioctl strioctl;
                    -
                    -
          strioctl.iccmd = cmd;
          strioctl.ictimeout = INFTIM;
          strioctl.iclen = size;
          strioctl.icdp = (char *)buf
          ioctl(fildes, ISTR, &strioctl);

     Whereas when issued, size is the size of the appropriate TI message to
     be sent to the transport provider, on return size is the size of the
     appropriate TI message from the transport provider in response to the
     issued TI message. buf is a pointer to a buffer large enough to hold
     the contents of the appropriate TI messages. The TI message types are
     defined in <sys/tihdr.h>. The possible values for the cmd field are:

     TIBIND        Bind an address to the underlying transport protocol
                    provider. The message issued to the TIBIND ioctl is
                    equivalent to the TI message type TBINDREQ and the
                    message returned by the successful completion of the
                    ioctl is equivalent to the TI message type TBINDACK.

     TIUNBIND      Unbind an address from the underlying transport proto-
                    col provider. The message issued to the TIUNBIND ioctl
                    is equivalent to the TI message type TUNBINDREQ and
                    the message returned by the successful completion of
                    the ioctl is equivalent to the TI message type
                    TOKACK.




Page 1                       Reliant UNIX 5.44                Printed 11/98

timod(7)                                                           timod(7)

     TIGETINFO     Get the TI protocol specific information from the
                    transport protocol provider. The message issued to the
                    TIGETINFO ioctl is equivalent to the TI message type
                    TINFOREQ and the message returned by the successful
                    completion of the ioctl is equivalent to the TI message
                    type TINFOACK.

     TIOPTMGMT     Get, set or negotiate protocol specific options with
                    the transport protocol provider. The message issued to
                    the TIOPTMGMT ioctl is equivalent to the TI message
                    type TOPTMGMTREQ and the message returned by the suc-
                    cessful completion of the ioctl is equivalent to the TI
                    message type TOPTMGMTACK.

DIAGNOSTICS
     If the ioctl system call returns with a value greater than 0, the
     lower 8 bits of the return value will be one of the TI error codes as
     defined in <sys/tiuser.h>. If the TI error is of type TSYSERR, then
     the next 8 bits of the return value will contain an error as defined
     in <sys/errno.h> [see introprm2(2)].

FILES
     <sys/timod.h>

     <sys/tiuser.h>

     <sys/tihdr.h>

     <sys/errno.h>

SEE ALSO
     tirdwr(7).

     Programmer's Guide: STREAMS

     Programmer's Guide: Networking Interfaces


















Page 2                       Reliant UNIX 5.44                Printed 11/98