Ace_TCP_Stream_Bytes_Get()
Abstract
Gets a specified amount of data from a TCP stream.
Syntax
Ace_TCP_Stream_Bytes_Get (stream_ptr, num_bytes, buffer_ptr, packet_lptr)
| Argument | Type | Description |
|---|---|---|
stream_ptr |
AceT_TCP_Stream * |
TCP stream of interest. |
num_bytes |
int |
Amount of data to retrieve, in bytes. |
buffer_ptr |
AceT_Buffer * |
Buffer to be filled with retrieved data. |
packet_lptr |
PrgT_List * |
List of packets used from TCP stream. |
Return Type
Status code indicating result of operation (one of the values shown in Table 3 TCP Stream Sub-Package Symbolic Constants).
Header
ace_client_api.h
Example
if ((stream_status = Ace_TCP_Stream_Bytes_Get (stream_ptr, byte_count, buffer_ptr,
pk_lptr)) == AceC_TCP_Stream_OK)
{
processed_bytes = Ace_Buffer_Data_Get (buffer_ptr, &num_processed_bytes);
Details
This function retrieves the next num_bytes of data from the specified TCP stream and moves the current location of the stream forward to the next unread byte.