TipcSrvConnGetGmdMaxSize

Name

TipcSrvConnGetGmdMaxSize — determine the GMD area maximum size of the connection

Synopsis

T_BOOL TipcSrvConnGetGmdMaxSize(srv, gmd_max_size_return) 
T_IPC_SRV srv; 
T_UINT4 *gmd_max_size_return; 

Arguments

srv — connection handle to RTserver

gmd_max_size_return — storage for connection to RTserver GMD area maximum size

Return Values

TRUE if the GMD area maximum size was successfully retrieved from the connection handle to RTserver, FALSE otherwise.

Diagnostics

If TipcSrvConnGetGmdMaxSize fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcSrvConnGetGmdMaxSize gets the GMD area maximum size (in bytes) of the connection handle to RTserver by calling TipcConnGetGmdMaxSize. A GMD area holds guaranteed message delivery information for both incoming and outgoing messages. There are two types of guaranteed message delivery: file-based GMD and memory-only GMD. See TipcConnGmdFileCreate for more information on GMD areas.

For file-based GMD this limit is the maximum file size, and for memory-only GMD this limit is the maximum amount of memory allowed. The default GMD area maximum size is 0, which means that no GMD area maximum size limit checking is performed. The connection GMD area maximum size and the connection delivery timeout can be used to constrain the amount of system resources used for GMD by space and by time.

If the connection GMD area maximum size is exceeded, then no further messages can be sent with guaranteed delivery (TipcSrvConnMsgSend returns FALSE and sets the global SmartSockets error number to T_ERR_VAL_TOO_LARGE) until some unacknowledged previously sent messages are acknowledged.

TipcSrvConnGetGmdMaxSize may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnGetGmdMaxSize gets the GMD area maximum size of the warm connection. See TipcSrvConnOpen for more information on automatic creation of connections and warm connections to RTserver.

Caution

If TipcSrvConnGetGmdMaxSize returns FALSE, it does not store a value in gmd_max_size_return.

See Also

TipcConnGetGmdMaxSize, TipcSrvConnGmdFileCreate, TipcSrvConnSetGmdMaxSize

Examples

This example prints the GMD area maximum size of the connection handle to RTserver:

T_IPC_SRV srv; 
T_INT4 gmd_max_size_return; 
 
if (!TipcSrvConnGetGmdMaxSize(srv, &gmd_max_size_return)) { 
  return;  /* error */ 
}  
 
TutOut("Connection to RTserver GMD max size is %d.\n", 
gmd_max_size);