Specifications

HighWire MTP-2 - 1.2, September 4, 2002 Basic Interface Functions and API Calls 37
Returns.
• CBI_RC_SYNC_COMPLETE if a message was successfully obtained.
• CBI_RC_ASYNC_COMPLETE if only part of a message was available. In
this case, the buffers returned to the application contain only a partial
message and should not be used. The next time the library signals that
another message is available, the same buffers should be passed back to
the library and the remainder of the message will be filled in.
• CBI_RC_NO_MSG if no message was available for the user (i.e. the
message was destined for the library itself).
• CBI_RC_INVALID if an invalid correlator was specified.
4-3-6. cbi_send Prototype.
CBI_UINT32 cbi_send(
CBI_CORR cbi_correlator,
char * ctrl_buf,
char * data_buf)
Description. This routine supplies a message to the library for dispatch to a
line card. This call does not block.
Parameters.
Returns.
• CBI_RC_SYNC_COMPLETE if the message was sent in a synchronous
fashion.
• CBI_RC_ASYNC_COMPLETE indicates that the message has not been
completely sent due to a flow control condition; the user must re-transmit
any flow controlled message once resources become availabe for cross
bus transfer.
• CBI_RC_IO_ERROR indicates that there is a problem with the
communication pipeline to the line card and that the user must close and
reopen the connection to reestablish communication.
• CBI_RC_INVALID indicates that the supplied correlator is invalid.
cbi_correlator The correlator identifying the line card for which the
message is destined.
ctrl_buf A pointer to a control buffer. Note that the length of the
control buffer is determined by the ctrl_size field in the
CBI_IPS structure which is always present in the control
buffer for messages with an associated data component.
data_buf A pointer to a data buffer. Note that the length and offset
of the data in the data buffer are determined by the
data_len and data_start fields in the CBI_PKT_HDR
structure, which is always present in the control buffer for
messages with an associated data component.