bstr_port_receive_packet(3) — Subroutines

Name

bstr_port_receive_packet − Receives a Packet notification queued at a Port (VODB only).

Syntax

bstr_t_status   bstr_port_receive_packet (
                          bstr_t_reference             ∗port,
                          bstr_t_rcb                   ∗control,
                          bstr_t_packet_notification   ∗packet_notification);

Description

The bstr_port_receive_packet procedure allows an application to receive a Packet notification pending at the Port specified by port. The information associated with the notification is returned in the bsr_t_packet_notification data structure addressed by packet_notification.

The bstr_port_receive_packet procedure can only be invoked for a Port if the application previously issued the bstr_port_connect procedure for that Port.

Only one call to the bstr_port_receive_packet procedure can be queued at a Port at any given time.

Arguments

port
access: read
The reference to the Port from which the Packet notification is to be received.

control
access: read
The address of an optional request control block.

packet_notification
access: read/write
The address of a bstr_t_packet_notification type data structure, in which the procedure returns the information associated with the received Packet notification.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_ALREADY_ACTIVE	Operation already active
BSTR_S_BAD_PARAMETER	Bad parameter value
BSTR_S_BAD_REFERENCE	Bad reference
BSTR_S_COMMUNICATION_ERROR	Communication error
BSTR_S_COM_PC_SIZE_MISMATCH	Number of bytes requested does not match the number of bytes returned
BSTR_S_FINISH	Request aborted by bstr_finish
BSTR_S_INTERNAL_ERROR	Internal error
BSTR_S_INTR	Operation interrupted
BSTR_S_INVALID_OPERATION	Invalid operation
BSTR_S_INVALID_RCB	Invalid Request Control Block
BSTR_S_INVALID_USAGE	Invalid reference usage
BSTR_S_NORMAL	Normal successful completion
BSTR_S_NOT_IMPLEMENTED	Not yet implemented
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized
BSTR_S_NO_MEMORY	Insufficient virtual memory
BSTR_S_REFERENCE_IN_USE	Reference already in use
BSTR_S_SEQUENCE_IN_USE	Sequence already in use
BSTR_S_SERVER_NOT_REACHABLE	Server not reachable
BSTR_S_TIMEOUT	Timeout expired
BSTR_S_TOO_MANY_REQUESTS	Too many pending requests
BSTR_S_PORT_NOT_CONNECTED	Not connected to Port

Museum