gsk_attribute_set_numeric

Sets a numeric value.

Format

   #include <gskssl.h>

   gsk_status gsk_attribute_set_numeric_value (
                                                gsk_handle     ssl_handle,
                                                GSK_NUM_ID     num_id,
                                                int            num_value)

Parameters

ssl_handle: Specifies an SSL environment handle returned by gsk_environment_open() or an SSL connection handle returned by gsk_secure_socket_open().
num_id: Specifies the numeric identifier.
num_value: Specifies the numeric value.

Results

The function return value will be 0 (GSK_OK) if no error is detected. Otherwise, it will be one of the return codes listed in the gskssl.h include file. These are some possible errors:

[GSK_ATTRIBUTE_INVALID_ID]: The numeric identifier is not valid or cannot be used with the specified handle.
[GSK_ATTRIBUTE_INVALID_NUMERIC_VALUE]: The numeric value is not within the valid range.
[GSK_INVALID_HANDLE]: The handle is not valid.
[GSK_INVALID_STATE]: The environment or connection is not in the open state.

Usage

The gsk_attribute_set_numeric_value() routine sets a numeric value for an SSL environment or an SSL connection. The environment or connection must be in the open state and not in the initialized state (that is, gsk_environment_init() or gsk_secure_socket_init() has not been called).

These numeric identifiers are supported:

GSK_CRL_CACHE_TIMEOUT: Sets the CRL cache timeout. This is the number of hours that a cached CRL remains valid. The range is 0-720 and defaults to 24. A value of 0 disables CRL caching. GSK_CRL_CACHE_TIMEOUT can be specified only for an SSL environment.
GSK_FD: Sets the socket descriptor for network operations. GSK_FD can be specified only for an SSL connection. The socket must not be closed until the gsk_secure_socket_close() routine has been called to terminate the secure connection.
GSK_LDAP_SERVER_PORT: Sets the LDAP server port. The port must be between 1 and 65535. Port 389 will be used if no LDAP server port is set. GSK_LDAP_SERVER_PORT can be specified only for an SSL environment. GSK_LDAP_SERVER_PORT can be specified only for an SSL environment.
GSK_V2_SESSION_TIMEOUT: Sets the SSL Version 2 session timeout. This is the number of seconds until an SSL V2 session identifier expires. The range is 0-100 and defaults to 100. System SSL remembers SSL V2 session identifiers for this amount of time. This reduces the amount of data exchanged during the SSL handshake when a complete initial handshake is performed. Session identifiers are not remembered if a value of 0 is specified. GSK_V2_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V2_SIDCACHE_SIZE: Sets the size of the SSL Version 2 session identifier cache. The oldest entry is removed when the cache is full to add a new entry. The range is 0-32000 and defaults to 256. Session identifiers are not remembered if a value of 0 is specified. The session identifier cache is allocated using the requested size rounded up to a power of 2 with a minimum size of 16. GSK_V2_SIDCACHE_SIZE can be specified only for an SSL environment.
GSK_V3_SESSION_TIMEOUT: Sets the session timeout for the SSL V3, TLS V1.0, or higher protocols. This is the number of seconds until an SSL V3 session identifier expires. The range is 0-86400 and defaults to 86400. System SSL remembers session identifiers for this amount of time. This reduces the amount of data exchanged during the SSL handshake when a complete initial handshake has already been performed. Session identifiers are not remembered if a value of 0 is specified. GSK_V3_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V3_SIDCACHE_SIZE: Sets the size of the SSL Version 3 session identifier cache. The oldest entry will be removed when the cache is full to add a new entry. The range is 0-64000 and defaults to 512. Session identifiers are not remembered if a value of 0 is specified. The SSL V3 session cache is used for the SSL V3, TLS V1.0, or higher protocols. The session identifier cache is allocated by using the requested size rounded up to a power of 2 with a minimum size of 16. GSK_V3_SIDCACHE_SIZE can be specified only for an SSL environment.

Format

Parameters

Results

Usage

Related Topics