ipc_$wait — Apollo

IPC_$WAIT                         Domain/OS                          IPC_$WAIT


NAME
     ipc_$wait - wait for an IPC datagram

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/ipc.h>

     void ipc_$wait(
          ipc_$socket_handle_t socket_handle,
          unsigned short &wait_time,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/ipc.ins.pas';

     procedure ipc_$wait(
          in socket_handle: ipc_$socket_handle_t;
          in wait_time: pinteger;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/ipc.ins.ftn'

           integer*2 wait_time
           integer*4 status
           character socket_handle*20

           call ipc_$wait(socket_handle, wait_time, status)

DESCRIPTION
     Ipc_$wait waits for up to wait_time quarter-seconds for a datagram to
     arrive at the socket on socket_handle.  Ipc_$wait returns when there is a
     datagram at the socket or after wait_time quarter-seconds have elapsed.
     It returns immediately if there is a datagram available when it is
     called.

     socket_handle
          The handle for the socket to wait on.

     wait_time
          The number of quarter-seconds to wait.

     status
          The completion status.  If a datagram arrives in time, ipc_$wait
          returns with the status status_$ok.  If ipc_$wait times out before a
          datagram is received, it returns with the status ipc_$timeout.

SEE ALSO
     ipc_$rcv, ipc_$sar.
Museum
