TipcConnSetGmdMaxSize

Name

TipcConnSetGmdMaxSize — set the GMD area maximum size of a connection

Synopsis

T_BOOL TipcConnSetGmdMaxSize(conn, gmd_max_size) 
T_IPC_CONN conn; 
T_UINT4 gmd_max_size; 

Arguments

conn — connection to set GMD area maximum size for

gmd_max_size — connection GMD area maximum size (in bytes)

Return Values

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

Diagnostics

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

Description

TipcConnSetGmdMaxSize sets the GMD area maximum size of a connection. 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 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 (TipcConnMsgSend returns FALSE and sets the global SmartSockets error number to T_ERR_VAL_TOO_LARGE) until some unacknowledged previously sent messages are acknowledged.

Caution

None

See Also

TipcConnGmdFileCreate, TipcConnGetGmdMaxSize, TipcSrvGetGmdMaxSize

Examples

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

if (!TipcConnSetGmdMaxSize(conn, 1000000)) { 
  return;  /* error */ 
}