common_types.h File Reference

Common types that don't fit anywhere else. More...

Data Structures
struct	CONNECTION_RESPONSE_T

Macros
#define	DIFFUSION_FALSE
	Constant used in the API to indicate "false".
#define	DIFFUSION_TRUE
	Constant used in the API to indicate "true".
#define	HANDLER_SUCCESS
	Constant used in the API to indicate that a message or service handler has completed successfully.
#define	HANDLER_FAILURE
	Constant used in the API to indicate that a message or service handler has failed with an error.
#define	COMMAND_TOPIC_NAME
	Constant defining the V5 service/control topic name.

Enumerations
enum	MESSAGE_PRIORITY_T
	Priority for messages being sent to Diffusion. More...
enum	CLIENT_SEND_PRIORITY_T
	Priority of messages that Diffusion sends to control clients via the send_client() call.
enum	SESSION_CLOSE_REASON_T { , SESSION_CLOSE_REASON_SERVER_CLOSING }
	Reasons for session closure. More...
enum	CONNECTION_RESPONSE_CODE_T
	Connection response codes.

Detailed Description

Common types that don't fit anywhere else.

Copyright © 2014, 2021 Push Technology Ltd., All Rights Reserved.

Use is subject to license terms.

NOTICE: All information contained herein is, and remains the property of Push Technology. The intellectual and technical concepts contained herein are proprietary to Push Technology and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.

Enumeration Type Documentation

enum MESSAGE_PRIORITY_T

Priority for messages being sent to Diffusion.

The default is MEDIUM for most messages.

IMMEDIATE priority messages are for system use only, and should not by used by the user.

enum SESSION_CLOSE_REASON_T

Reasons for session closure.

Enumerator
SESSION_CLOSE_REASON_SERVER_CLOSING	SESSION_CLOSE_REASON_SERVER_CLOSING has been deprecated from version 6.6 onwards, and will be removed in a future release.