ChannelInfo.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MAX_CONTROL_PLANE_URI_CHAR_LEN   256
#define	MAX_DESCRIBE_CHANNEL_STATUS_LEN   32
#define	MAX_DESCRIBE_CHANNEL_TYPE_LEN   128
#define	SIGNALING_CHANNEL_TYPE_UNKNOWN_STR   (PCHAR) "UNKOWN"
#define	SIGNALING_CHANNEL_TYPE_SINGLE_MASTER_STR   (PCHAR) "SINGLE_MASTER"
#define	SIGNALING_CHANNEL_ROLE_TYPE_UNKNOWN_STR   (PCHAR) "UNKOWN"
#define	SIGNALING_CHANNEL_ROLE_TYPE_MASTER_STR   (PCHAR) "MASTER"
#define	SIGNALING_CHANNEL_ROLE_TYPE_VIEWER_STR   (PCHAR) "VIEWER"
#define	MIN_SIGNALING_MESSAGE_TTL_VALUE   (5 * HUNDREDS_OF_NANOS_IN_A_SECOND)
#define	MAX_SIGNALING_MESSAGE_TTL_VALUE   (120 * HUNDREDS_OF_NANOS_IN_A_SECOND)
#define	SIGNALING_USER_AGENT_POSTFIX_NAME   (PCHAR) "AWS-WEBRTC-KVS-AGENT"
#define	SIGNALING_USER_AGENT_POSTFIX_VERSION   (PCHAR) "UNKNOWN"

Functions
STATUS	createValidateChannelInfo (PChannelInfo, PChannelInfo *)
STATUS	freeChannelInfo (PChannelInfo *)
SIGNALING_CHANNEL_STATUS	getChannelStatusFromString (PCHAR, UINT32)
SIGNALING_CHANNEL_TYPE	getChannelTypeFromString (PCHAR, UINT32)
PCHAR	getStringFromChannelType (SIGNALING_CHANNEL_TYPE)
SIGNALING_CHANNEL_ROLE_TYPE	getChannelRoleTypeFromString (PCHAR, UINT32)
PCHAR	getStringFromChannelRoleType (SIGNALING_CHANNEL_ROLE_TYPE)
STATUS	validateKvsSignalingChannelArnAndExtractChannelName (PChannelInfo, PUINT16, PUINT16)

Macro Definition Documentation

MAX_CONTROL_PLANE_URI_CHAR_LEN

#define MAX_CONTROL_PLANE_URI_CHAR_LEN   256

MAX_DESCRIBE_CHANNEL_STATUS_LEN

#define MAX_DESCRIBE_CHANNEL_STATUS_LEN   32

MAX_DESCRIBE_CHANNEL_TYPE_LEN

#define MAX_DESCRIBE_CHANNEL_TYPE_LEN   128

MAX_SIGNALING_MESSAGE_TTL_VALUE

#define MAX_SIGNALING_MESSAGE_TTL_VALUE   (120 * HUNDREDS_OF_NANOS_IN_A_SECOND)

MIN_SIGNALING_MESSAGE_TTL_VALUE

#define MIN_SIGNALING_MESSAGE_TTL_VALUE   (5 * HUNDREDS_OF_NANOS_IN_A_SECOND)

SIGNALING_CHANNEL_ROLE_TYPE_MASTER_STR

#define SIGNALING_CHANNEL_ROLE_TYPE_MASTER_STR   (PCHAR) "MASTER"

SIGNALING_CHANNEL_ROLE_TYPE_UNKNOWN_STR

#define SIGNALING_CHANNEL_ROLE_TYPE_UNKNOWN_STR   (PCHAR) "UNKOWN"

SIGNALING_CHANNEL_ROLE_TYPE_VIEWER_STR

#define SIGNALING_CHANNEL_ROLE_TYPE_VIEWER_STR   (PCHAR) "VIEWER"

SIGNALING_CHANNEL_TYPE_SINGLE_MASTER_STR

#define SIGNALING_CHANNEL_TYPE_SINGLE_MASTER_STR   (PCHAR) "SINGLE_MASTER"

SIGNALING_CHANNEL_TYPE_UNKNOWN_STR

#define SIGNALING_CHANNEL_TYPE_UNKNOWN_STR   (PCHAR) "UNKOWN"

SIGNALING_USER_AGENT_POSTFIX_NAME

#define SIGNALING_USER_AGENT_POSTFIX_NAME   (PCHAR) "AWS-WEBRTC-KVS-AGENT"

SIGNALING_USER_AGENT_POSTFIX_VERSION

#define SIGNALING_USER_AGENT_POSTFIX_VERSION   (PCHAR) "UNKNOWN"

Function Documentation

createValidateChannelInfo()

STATUS createValidateChannelInfo	(	PChannelInfo	pOrigChannelInfo,
		PChannelInfo *	ppChannelInfo
	)

Takes in a pointer to a public version of ChannelInfo object. Validates and creates an internal object

Returns

- STATUS code of the execution

Here is the call graph for this function:

Here is the caller graph for this function:

freeChannelInfo()

STATUS freeChannelInfo

(

PChannelInfo *

ppChannelInfo

)

Frees the channel info object.

Parameters

-	PChannelInfo* - IN - Channel info object to free

Returns

- STATUS code of the execution

Here is the caller graph for this function:

getChannelRoleTypeFromString()

SIGNALING_CHANNEL_ROLE_TYPE getChannelRoleTypeFromString	(	PCHAR	type,
		UINT32	length
	)

Returns the signaling channel Role from a string

Parameters

-	PCHAR - IN - String representation of the channel role
-	UINT32 - IN - String length

Returns

- Signaling channel type

getChannelStatusFromString()

SIGNALING_CHANNEL_STATUS getChannelStatusFromString	(	PCHAR	status,
		UINT32	length
	)

Returns the signaling channel status from a string

Parameters

-	PCHAR - IN - String representation of the channel status
-	UINT32 - IN - String length

Returns

- Signaling channel status type

Here is the caller graph for this function:

getChannelTypeFromString()

SIGNALING_CHANNEL_TYPE getChannelTypeFromString	(	PCHAR	type,
		UINT32	length
	)

Returns the signaling channel type from a string

Parameters

-	PCHAR - IN - String representation of the channel type
-	UINT32 - IN - String length

Returns

- Signaling channel type

Here is the caller graph for this function:

getStringFromChannelRoleType()

PCHAR getStringFromChannelRoleType

(

SIGNALING_CHANNEL_ROLE_TYPE

type

)

Returns the signaling channel role type string

Parameters

-	SIGNALING_CHANNEL_TYPE - IN - Signaling channel type

Returns

- Signaling channel type string

Here is the caller graph for this function:

getStringFromChannelType()

PCHAR getStringFromChannelType

(

SIGNALING_CHANNEL_TYPE

type

)

Returns the signaling channel type string

Parameters

-	SIGNALING_CHANNEL_TYPE - IN - Signaling channel type

Returns

- Signaling channel type string

Here is the caller graph for this function:

validateKvsSignalingChannelArnAndExtractChannelName()

STATUS validateKvsSignalingChannelArnAndExtractChannelName	(	PChannelInfo	pChannelInfo,
		PUINT16	pStart,
		PUINT16	pNumChars
	)

Determines whether or not the channel arn is valid If VALID it extracts the channel name And Sets the pChannelName field in PChannelInfo

Parameters

-	PChannelInfo - IN - channel info object
-	PUINT16 - OUT - start index of the arn (if valid) where the channel name is
-	PUINT16 - OUT - number of characters for the arn (if valid)

Returns

- success if arn was valid otherwise failure

Here is the caller graph for this function: