TipcSrvConnSetGmdMaxSize

Name

TipcSrvConnSetGmdMaxSize — set the GMD area maximum size of the connection

Synopsis

T_BOOL TipcSrvConnSetGmdMaxSize(srv, gmd_max_size) 
T_IPC_SRV srv; 
T_UINT4 gmd_max_size; 

Arguments

srv — connection handle to RTserver

gmd_max_size — connection to RTserver GMD area maximum size (in bytes)

Return Values

TRUE if the GMD area maximum size was successfully set for the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnSetGmdMaxSize sets the GMD area maximum size in bytes of the connection to RTserver by calling TipcConnSetGmdMaxSize. A GMD area holds guaranteed message delivery information for incoming and outgoing messages. There are two types of guaranteed message delivery: file-based and memory-only. 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 or by time.

If the connection GMD area maximum size is exceeded, 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.

TipcSrvConnSetGmdMaxSize may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnSetGmdMaxSize sets 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

None

See Also

TipcConnSetGmdMaxSize, TipcSrvConnGmdFileCreate, TipcSrvConnGetGmdMaxSize

Examples

This example sets the GMD area maximum size of the connection to RTserver to one million bytes:

if (!TipcSrvConnSetGmdMaxSize(srv, 1000000)) { 
  return;  /* error */ 
}