Museum

SYSCALLS/MBX - mailbox manager module                           1987/01/22


Include files:

     C:          /sys/ins/mbx.ins.c
     Fortran:    /sys/ins/mbx.ins.ftn
     Pascal:     /sys/ins/mbx.ins.pas

NOTE: If you use the mailbox manager for INTER-NODE interprocess
      communication, the participating nodes must all be running the
      MBX_HELPER process. The program that implements this process
      is "/SYS/MBX/MBX_HELPER" and can be run either in a normal
      process or started via the Display Manager CPO command, as:

           Command: CPO  /SYS/MBX/MBX_HELPER


Procedures and Functions:


    size = MBX_$CLIENT_WINDOW (handle, status)
        Returns the buffer size for the mailbox that a client is using.

    MBX_$CLOSE (handle, status)
        Closes a mailbox or a channel.

    MBX_$COND_GET_REC_CHAN (handle, channel, bufptr, buflen, retptr, retlen,
                            status)
        Attempts to get a mailbox message from a specified channel.

    MBX_$COND_GET_REC_CHAN_SET (handle, chan-set, bufptr, buflen, retptr,
                                retlen, status)
        Attempts to get a mailbox record from a set of clients.

    MBX_$CREATE_SERVER (name, namelen, bufsize, maxchan, handle, status)
        Creates and opens a server's mailbox.

    MBX_$DEALLOCATE (handle, channel, status)
        Releases a channel for use by another client.

    MBX_$GET_CONDITIONAL (handle, bufptr, buflen, retptr, retlen, status)
        Attempts to get a mailbox message.

    MBX_$GET_EC (mbx-handle, mbx-key, eventcount-pointer, status)
        Get pointer to eventcount for mailbox event mbx

    MBX_$GET_REC (handle, bufptr, buflen, retptr, retlen, status)
        Gets a message from a mailbox.

    MBX_$GET_REC_CHAN (handle, channel, bufptr, buflen, retptr, retlen,
                       status)
        Gets a mailbox message from a specified channel.

    MBX_$GET_REC_CHAN_SET (handle, chan-set, bufptr, buflen, retptr, retlen,
                           status)
        Gets a mailbox message from a specified set of channels.

    MBX_$OPEN (name, namelen, bufptr, buflen, handle, status)
        Opens a client channel to a mailbox.

    MBX_$PUT_CHR  (handle, bufptr, buflen, status)
        Sends a partial message from a client.

    MBX_$PUT_CHR_COND  (handle, bufptr, buflen, status)
        Attempts to send a partial message from a client.

    MBX_$PUT_REC (handle, bufptr, buflen, status)
        Puts a record in the mailbox.

    MBX_$PUT_REC_COND (handle, bufptr, buflen, status)
        Attempts to put a message into a mailbox.

    size = MBX_$SERVER_WINDOW (handle, channel, status)
        Returns the buffer size for the mailbox maintained by the
        MBX_HELPER on a remote client's node.

    MBX_$TIMED_OPEN (name, namelen, bufptr, buflen, wait-time, handle,
                     status)
        Attempts to open a client channel to a mailbox within a specified
        time period.