int ServerTCPRead (unsigned int conversationHandle, void *dataBuffer, unsigned int dataSize, unsigned int timeout);
Allows your program, acting as a TCP server, to read data from a client.
The function waits until data is available at the port or until the specified interval expires.
![]() |
Note  If the function call is successful the return value is the number of bytes read. It is possible that TCP is not able to read all the data in one call. If necessary, you can check the number of bytes read and call this function repeatedly to read the rest of the data as shown in the following example: |
char * buffer;
int messageSize;
int bytesToRead;
int bytesRead;
/* Find messageSize and allocate buffer appropriately... */
bytesToRead = messageSize;
while (bytesToRead > 0)
{
bytesRead = ServerTCPRead (connectionHandle, &buffer[messageSize - bytesToRead], bytesToRead, 0);
bytesToRead -= bytesRead;
}
Input | ||
Name | Type | Description |
conversationHandle | unsigned integer | The conversation handle that uniquely represents the connection between the server and the client. |
dataBuffer | void pointer | The pointer to the buffer in which to store the data. NULL is not allowed. |
dataSize | unsigned integer | The maximum number of bytes to read. dataSize must be less than or equal to the size of dataBuffer. |
timeout | unsigned integer | Number of milliseconds that ServerTCPRead waits for data to be available on the connection. ServerTCPRead returns as soon as it reads some data from the connection. The function waits the entire timeout period only if no data is available. If you pass zero, the function uses a default timeout of 5,000 milliseconds. |
Name | Type | Description |
status | integer | Return value indicating whether the function was successful. Unless otherwise
stated, zero represents successful execution and a negative number represents
the error code. You can call the GetTCPSystemErrorString function to obtain a system message that describes the error. The system messages can be more descriptive than the TCP Library error codes. To obtain the correct system error message, you must call GetTCPSystemErrorString immediately after calling the TCP Library function that failed. For functions that read or write data (ClientTCPRead, ClientTCPWrite, ServerTCPRead, ServerTCPWrite), if the function was successful, the return value is the number of bytes transferred. You can have a maximum of 255 concurrent conversations and up to 1,024 connections. If you exceed this limit, |