 |
PubSub+ Messaging API For C
7.31.0.7
|
|
| Functions | Typedefs | Enumerations | Enumeration Values | Defines |
|
PubSub+ Messaging API For C
7.31.0.7
|
|
| Functions | Typedefs | Enumerations | Enumeration Values | Defines |
Default values for Session configuration properties that are not explicitly set. More...
Default values for Session configuration properties that are not explicitly set.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_AD_PUB_ROUTER_WINDOWED_ACK SOLCLIENT_PROP_ENABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_AD_PUB_ROUTER_WINDOWED_ACK.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_APPLICATION_DESCRIPTION "" |
The default value for the application description.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_AUTHENTICATION_SCHEME SOLCLIENT_SESSION_PROP_AUTHENTICATION_SCHEME_BASIC |
The default value for SOLCLIENT_SESSION_PROP_AUTHENTICATION_SCHEME.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_BIND_IP "" |
The default value for local IP on connect is unset (bind to any) .
| #define SOLCLIENT_SESSION_PROP_DEFAULT_BLOCK_WHILE_CONNECTING SOLCLIENT_PROP_ENABLE_VAL |
The default is to block operations such as sending a message, subscribing, or unsubscribing if the Session is being connected.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_BLOCKING_WRITE_TIMEOUT_MS "100000" |
The default blocking write timeout (in milliseconds).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_BUFFER_SIZE "90000" |
The default size (in bytes) of internal buffer for transmit buffering.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CALCULATE_EXPIRATION_TIME SOLCLIENT_PROP_DISABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_CALCULATE_MESSAGE_EXPIRATION.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CLIENT_MODE SOLCLIENT_PROP_DISABLE_VAL |
Deprecated.
SOLCLIENT_SESSION_PROP_CLIENT_MODE is deprecated.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CLIENT_NAME "" |
The default Session Client Name is a null string to have the C API generate one.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_COMPRESSION_LEVEL "0" |
The default compression level (no compression).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CONNECT_BLOCKING SOLCLIENT_PROP_ENABLE_VAL |
The default is blocking connect operation.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CONNECT_RETRIES "0" |
The default number of connect retries.
Zero means only try once when connecting.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CONNECT_RETRIES_PER_HOST "0" |
The default number of connect retries per host.
Zero means only try once when connecting.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_CONNECT_TIMEOUT_MS "30000" |
The default connect timeout (in milliseconds).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GD_RECONNECT_FAIL_ACTION SOLCLIENT_SESSION_PROP_GD_RECONNECT_FAIL_ACTION_AUTO_RETRY |
The default action when the CCSMP API is unable to reestablish the publisher flow is to complete the reconnect on the session.
The CCSMP API will open a new publisher flow for the session, which may lead to publishing duplicate messages.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GENERATE_RCV_TIMESTAMPS SOLCLIENT_PROP_DISABLE_VAL |
The default receive message timestamps.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GENERATE_SEND_TIMESTAMPS SOLCLIENT_PROP_DISABLE_VAL |
The default for automatically include send message timestamps.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GENERATE_SENDER_ID SOLCLIENT_PROP_DISABLE_VAL |
The default for automatically include a sender id.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GENERATE_SEQUENCE_NUMBER SOLCLIENT_PROP_DISABLE_VAL |
The default for automatically include a sequence number.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_GUARANTEED_WITH_WEB_TRANSPORT SOLCLIENT_PROP_DISABLE_VAL |
The default for enabling guaranteed messaging with web transports.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_HOST "127.0.0.1" |
The default value for the broker IP address.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_IGNORE_DUP_SUBSCRIPTION_ERROR SOLCLIENT_PROP_ENABLE_VAL |
The default is ignore errors for duplicate subscription/topic on subscribe or unsubscribe.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_INITIAL_RECEIVE_BUFFER_SIZE "0" |
The default value for SOLCLIENT_SESSION_PROP_INITIAL_RECEIVE_BUFFER_SIZE.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_KEEP_ALIVE_INT_MS "3000" |
The default amount of time (in milliseconds) to wait between sending out Keep-Alive messages.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_KEEP_ALIVE_LIMIT "3" |
The default value for the number of consecutive Keep-Alive messages that can be sent without receiving a response before the connection is closed by the API.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_KRB_SERVICE_NAME "solace" |
The default for SOLCLIENT_SESSION_PROP_KRB_SERVICE_NAME.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_MODIFYPROP_TIMEOUT_MS "10000" |
The default amount of time (in milliseconds) to wait for session property modification.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_NO_LOCAL SOLCLIENT_PROP_DISABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_NO_LOCAL.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PASSWORD "" |
The default value for password.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PAYLOAD_COMPRESSION_LEVEL "0" |
The default payload compression level (no compression).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PORT "55555" |
The default value for the broker TCP port when compression is not in use (SOLCLIENT_SESSION_PROP_COMPRESSION_LEVEL of zero).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PORT_COMPRESSION "55003" |
The default value for the broker TCP port when compression is in use (SOLCLIENT_SESSION_PROP_COMPRESSION_LEVEL of non-zero).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PORT_SSL "55443" |
The default value for the broker SSL port over TCP regardless of compression.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PROVISION_TIMEOUT_MS "3000" |
The default amount of time (in milliseconds) to wait for a provision command.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PUB_ACK_TIMER "2000" |
The default value for publisher acknowledgment timer (in milliseconds).
When a published message is not acknowledged within the time specified for this timer, the API automatically retransmits the message. There is no limit on the number of retransmissions for any message. However, while the API is resending, applications can become flow controlled. The flow control behavior is controlled by SOLCLIENT_SESSION_PROP_SEND_BLOCKING and SOLCLIENT_SESSION_PROP_BLOCKING_WRITE_TIMEOUT_MS.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_PUB_WINDOW_SIZE "50" |
The default Publisher Window size for Guaranteed messages.
The Guaranteed Message Publish Window Size property limits the maximum number of messages that can be published before the API must receive an acknowledgment from the broker.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_REAPPLY_SUBSCRIPTIONS SOLCLIENT_PROP_DISABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_REAPPLY_SUBSCRIPTIONS.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_RECONNECT_RETRIES "0" |
The default number of reconnect retries.
Zero means no automatic connection retries after a Session goes down.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_RECONNECT_RETRY_WAIT_MS "3000" |
The default amount of time in (milliseconds) to wait before attempting a reconnect attempt.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SEND_BLOCKING SOLCLIENT_PROP_ENABLE_VAL |
The default is blocking send operation.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SOCKET_RCV_BUF_SIZE "150000" |
Use 0 to set the socket receive buffer size to the operating system default.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SOCKET_SEND_BUF_SIZE "90000" |
Use 0 to set the socket send buffer size to the operating system default.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SSL_CIPHER_SUITES ("ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-RSA-AES256-SHA,AES256-GCM-SHA384,AES256-SHA256,AES256-SHA,ECDHE-RSA-DES-CBC3-SHA,DES-CBC3-SHA,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-SHA256,ECDHE-RSA-AES128-SHA,AES128-GCM-SHA256,AES128-SHA256,AES128-SHA,RC4-SHA,RC4-MD5") |
The default value for SOLCLIENT_SESSION_PROP_SSL_CIPHER_SUITES.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SSL_EXCLUDED_PROTOCOLS "" |
The default value for SOLCLIENT_SESSION_PROP_SSL_EXCLUDED_PROTOCOLS.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SSL_VALIDATE_CERTIFICATE SOLCLIENT_PROP_ENABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_SSL_VALIDATE_CERTIFICATE.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SSL_VALIDATE_CERTIFICATE_DATE SOLCLIENT_PROP_ENABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_SSL_VALIDATE_CERTIFICATE_DATE.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SSL_VALIDATE_CERTIFICATE_HOST SOLCLIENT_PROP_ENABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_SSL_VALIDATE_CERTIFICATE_HOST.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SUBCONFIRM_TIMEOUT_MS "10000" |
The default subscription confirm (add or remove) timeout (in milliseconds).
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SUBSCRIBE_BLOCKING SOLCLIENT_PROP_ENABLE_VAL |
The default is blocking subscribe/unsubscribe operation.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SUBSCRIBER_LOCAL_PRIORITY "1" |
The default subscriber priority for locally published messages.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_SUBSCRIBER_NETWORK_PRIORITY "1" |
The default subscriber priority for remotely published messages.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_TCP_NODELAY SOLCLIENT_PROP_ENABLE_VAL |
The default value for TCP no delay.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_TOPIC_DISPATCH SOLCLIENT_PROP_DISABLE_VAL |
The default value for SOLCLIENT_SESSION_PROP_TOPIC_DISPATCH (see Dispatching Messages Based on a Topic)
| #define SOLCLIENT_SESSION_PROP_DEFAULT_TRANSPORT_PROTOCOL_DOWNGRADE_TIMEOUT_MS ("3000") |
The default value for the Transport Protocol downgrade timeout in milliseconds.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_UNBIND_FAIL_ACTION SOLCLIENT_SESSION_PROP_UNBIND_FAIL_ACTION_RETRY |
The default value for SOLCLIENT_SESSION_PROP_UNBIND_FAIL_ACTION.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_USERNAME "" |
The default value for username.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_VPN_NAME "" |
The default Message VPN name to connect this Session to.
The default is to not specify the VPN name; the default Message VPN provisioned on the broker is used.
| #define SOLCLIENT_SESSION_PROP_DEFAULT_WEB_TRANSPORT_PROTOCOL SOLCLIENT_TRANSPORT_PROTOCOL_NULL |
The default value for web messaging Transport Protocol.
Default is "use best available".