EngageSemNames.h File Reference

Object and field names used for interaction with Engage Semaphore Service. More...

Go to the source code of this file.

Macros
#define	ENSEM_JSON_OBJECT_NAME   "ensem"
	The root name of the JSON object.
#define	ENSEM_JSON_FIELD_MESSAGE_TYPE   "ty"
	Message type.
#define	ENSEM_JSON_FIELD_SEM_ID   "i"
	The semaphore identifier. Case insensitive.
#define	ENSEM_JSON_FIELD_MAX_OWNERS   "x"
	Maximum number of owners the semaphore may have.
#define	ENSEM_JSON_FIELD_WAITING_COUNT   "w"
	Number of tokens waiting on the semaphore.
#define	ENSEM_JSON_FIELD_OWNERS   "o"
	Array of semaphore owners.
#define	ENSEM_JSON_FIELD_TOKEN_ID   "t"
	The toekn identifier. Case insensitive.
#define	ENSEM_JSON_FIELD_OWNER_UNTIL   "u"
	Local timestamp (milliseconds) until ownership expires.
#define	ENSEM_JSON_FIELD_LOCAL_TIMESTAMP   "ts"
	Local 64-bit timestamp - typically number of milliseconds since Jan 1, 1970.
#define	ENSEM_JSON_FIELD_LOCAL_EXPIRATION_TIMESTAMP   "es"
	Local 64-bit timestamp when the token request will expire.
#define	ENSEM_JSON_FIELD_DURATION_MS   "r"
	Milliseconds of semaphore ownership.
#define	ENSEM_JSON_FIELD_PRIORITY   "p"
	Request priority 0 - 255.
#define	ENSEM_JSON_FIELD_SEM_USE   "us"
	The intended use of the semaphore.
#define	ENSEM_JSON_FIELD_SSRC   "s"
	The RTP SSRC associated with the stream the semaphore represents.
#define	ENSEM_JSON_FIELD_ALIAS   "a"
	The alias of the transmitter of the stream the semaphore represents.
#define	ENSEM_JSON_FIELD_DISPLAY_NAME   "d"
	The display name for the transmitter of the stream the semaphore represents.
#define	ENSEM_JSON_FIELD_NODE_ID   "n"
	The node ID for the transmitter of the stream the semaphore represents.

Detailed Description

Object and field names used for interaction with Engage Semaphore Service.

Definition in file EngageSemNames.h.

Macro Definition Documentation

ENSEM_JSON_FIELD_ALIAS

#define ENSEM_JSON_FIELD_ALIAS   "a"

The alias of the transmitter of the stream the semaphore represents.

Definition at line 56 of file EngageSemNames.h.

ENSEM_JSON_FIELD_DISPLAY_NAME

#define ENSEM_JSON_FIELD_DISPLAY_NAME   "d"

The display name for the transmitter of the stream the semaphore represents.

Definition at line 59 of file EngageSemNames.h.

ENSEM_JSON_FIELD_DURATION_MS

#define ENSEM_JSON_FIELD_DURATION_MS   "r"

Milliseconds of semaphore ownership.

Definition at line 44 of file EngageSemNames.h.

ENSEM_JSON_FIELD_LOCAL_EXPIRATION_TIMESTAMP

#define ENSEM_JSON_FIELD_LOCAL_EXPIRATION_TIMESTAMP   "es"

Local 64-bit timestamp when the token request will expire.

Definition at line 41 of file EngageSemNames.h.

ENSEM_JSON_FIELD_LOCAL_TIMESTAMP

#define ENSEM_JSON_FIELD_LOCAL_TIMESTAMP   "ts"

Local 64-bit timestamp - typically number of milliseconds since Jan 1, 1970.

Definition at line 38 of file EngageSemNames.h.

ENSEM_JSON_FIELD_MAX_OWNERS

#define ENSEM_JSON_FIELD_MAX_OWNERS   "x"

Maximum number of owners the semaphore may have.

Definition at line 23 of file EngageSemNames.h.

ENSEM_JSON_FIELD_MESSAGE_TYPE

#define ENSEM_JSON_FIELD_MESSAGE_TYPE   "ty"

Message type.

Definition at line 17 of file EngageSemNames.h.

ENSEM_JSON_FIELD_NODE_ID

#define ENSEM_JSON_FIELD_NODE_ID   "n"

The node ID for the transmitter of the stream the semaphore represents.

Definition at line 62 of file EngageSemNames.h.

ENSEM_JSON_FIELD_OWNER_UNTIL

#define ENSEM_JSON_FIELD_OWNER_UNTIL   "u"

Local timestamp (milliseconds) until ownership expires.

Definition at line 35 of file EngageSemNames.h.

ENSEM_JSON_FIELD_OWNERS

#define ENSEM_JSON_FIELD_OWNERS   "o"

Array of semaphore owners.

Definition at line 29 of file EngageSemNames.h.

ENSEM_JSON_FIELD_PRIORITY

#define ENSEM_JSON_FIELD_PRIORITY   "p"

Request priority 0 - 255.

Definition at line 47 of file EngageSemNames.h.

ENSEM_JSON_FIELD_SEM_ID

#define ENSEM_JSON_FIELD_SEM_ID   "i"

The semaphore identifier. Case insensitive.

Definition at line 20 of file EngageSemNames.h.

ENSEM_JSON_FIELD_SEM_USE

#define ENSEM_JSON_FIELD_SEM_USE   "us"

The intended use of the semaphore.

Definition at line 50 of file EngageSemNames.h.

ENSEM_JSON_FIELD_SSRC

#define ENSEM_JSON_FIELD_SSRC   "s"

The RTP SSRC associated with the stream the semaphore represents.

Definition at line 53 of file EngageSemNames.h.

ENSEM_JSON_FIELD_TOKEN_ID

#define ENSEM_JSON_FIELD_TOKEN_ID   "t"

The toekn identifier. Case insensitive.

Definition at line 32 of file EngageSemNames.h.

ENSEM_JSON_FIELD_WAITING_COUNT

#define ENSEM_JSON_FIELD_WAITING_COUNT   "w"

Number of tokens waiting on the semaphore.

Definition at line 26 of file EngageSemNames.h.

ENSEM_JSON_OBJECT_NAME

#define ENSEM_JSON_OBJECT_NAME   "ensem"

The root name of the JSON object.

Definition at line 14 of file EngageSemNames.h.