PubicEnums

Main enum declarations. More...

Enumerations
enum	HTTP_REQUEST_VERB { HTTP_REQUEST_VERB_GET , HTTP_REQUEST_VERB_POST , HTTP_REQUEST_VERB_PUT }
	Types of verbs. More...
enum	SSL_CERTIFICATE_TYPE { SSL_CERTIFICATE_TYPE_NOT_SPECIFIED , SSL_CERTIFICATE_TYPE_DER , SSL_CERTIFICATE_TYPE_PEM , SSL_CERTIFICATE_TYPE_ENG }
	Request SSL certificate type Not specified, "DER", "PEM", "ENG". More...
enum	API_CALL_CACHE_TYPE { API_CALL_CACHE_TYPE_NONE , API_CALL_CACHE_TYPE_ENDPOINT_ONLY , API_CALL_CACHE_TYPE_ALL }

Detailed Description

Main enum declarations.

Enumeration Type Documentation

API_CALL_CACHE_TYPE

enum API_CALL_CACHE_TYPE

Type of caching implementation to use with the callbacks provider

Enumerator
API_CALL_CACHE_TYPE_NONE	No caching. The callbacks provider will make backend API calls every time PIC requests. The backend API calls are emulated for all of the API calls with the exception of GetStreamingEndpoint and PutMedia (for actual streaming). The result of the GetStreamingEndpoint is cached and the cached value is returned next time PIC makes a request to call GetStreamingEndpoint call. NOTE: The stream should be pre-existing as DescribeStream API call will be emulated and will return a success with stream being Active.
API_CALL_CACHE_TYPE_ENDPOINT_ONLY	Cache all of the backend API calls with the exception of PutMedia (for actual data streaming). In this mode, the actual backend APIs will be called once and the information will be cached. The cached result will be returned afterwards when the PIC requests the provider to make the backend API call. This mode is the recommended mode for most of the streaming scenarios and is the default in the samples. NOTE: This mode is most suitable for streaming scenarios when the stream is not dynamically deleted or modified by another entity so the cached value of the API calls are static. NOTE: This mode will work for non-pre-created streams as the first call will not be cached for DescribeStream API call and if the stream is not created then the state machine will attempt to create it by calling CreateStream API call which would evaluate to the actual backend call to create the stream as it's not cached.
API_CALL_CACHE_TYPE_ALL

HTTP_REQUEST_VERB

enum HTTP_REQUEST_VERB

Types of verbs.

Enumerator
HTTP_REQUEST_VERB_GET	Indicates GET type of HTTP request.
HTTP_REQUEST_VERB_POST	Indicates POST type of HTTP request.
HTTP_REQUEST_VERB_PUT	Indicates PUT type of HTTP request.

SSL_CERTIFICATE_TYPE

enum SSL_CERTIFICATE_TYPE

Request SSL certificate type Not specified, "DER", "PEM", "ENG".

Enumerator
SSL_CERTIFICATE_TYPE_NOT_SPECIFIED	Default enum when type of certificate is not specified.
SSL_CERTIFICATE_TYPE_DER	Use DER type of SSL certificate if certificate to use is *.der.
SSL_CERTIFICATE_TYPE_PEM	Use PEM type of SSL certificate if certificate to use is *.pem.
SSL_CERTIFICATE_TYPE_ENG	Use ENG type of SSL certificate if certificate to use is *.eng.