TutSocketSetBlockMode

Name

TutSocketSetBlockMode — set the block mode of a socket

Synopsis

T_BOOL TutSocketSetBlockMode(socket_fd, block_mode) 
T_INT4 socket_fd; 
T_BOOL block_mode;

Arguments

socket_fd — socket file descriptor to set block mode for

block_mode — block mode to apply to socket_fd

Return Values

TRUE if block mode was successfully set for socket, FALSE otherwise.

Diagnostics

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

T_ERR_C — a C error has occurred. The function TutErrNumGetC should be called to obtain the related C error value.

T_ERR_OS — an operating system error has occurred. The function TutErrNumGetOs should be called to obtain the related OS error value.

T_ERR_SOCKET — a socket error has occurred. The function TutErrNumGetSocket should be called to obtain the related socket error value.

T_ERR_VAL_TOO_SMALL — the socket file descriptor was a negative number

T_ERR_VAL_INVALID — the block mode was not TRUE or FALSE

Description

TutSocketSetBlockMode sets the block mode of socket_fd. See TutSocketGetBlockMode on page 268 for more information on socket block modes. A value of TRUE for block_mode makes I/O operations blocking, and FALSE makes I/O operations non-blocking.

Caution

None

Examples

This example sets the block mode of a socket to FALSE:

if (!TutSocketSetBlockMode(socket_fd, FALSE)) { 
  /* error */ 
}