Photon C++ Client API  4.1.15.3
Public Member Functions | List of all members
WebFlags Class Reference
Inheritance diagram for WebFlags:
Inheritance graph
[legend]
Collaboration diagram for WebFlags:
Collaboration graph
[legend]

Public Member Functions

 WebFlags (nByte webFlags=0)
 
nByte getFlags (void) const
 
WebFlagssetFlags (nByte webFlags)
 
bool getHttpForward (void) const
 
WebFlagssetHttpForward (bool httpWebForward)
 
bool getSendAuthCookie (void) const
 
WebFlagssetSendAuthCookie (bool sendAuthCookie)
 
bool getSendSync (void) const
 
WebFlagssetSendSync (bool sendSync)
 
bool getSendState (void) const
 
WebFlagssetSendState (bool sendState)
 
virtual Common::JStringtoString (Common::JString &retStr, bool withTypes=false) const
 
- Public Member Functions inherited from Base
virtual ~Base (void)
 
- Public Member Functions inherited from ToString
virtual ~ToString (void)
 
virtual JString typeToString (void) const
 
JString toString (bool withTypes=false) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Base
static void setListener (const BaseListener *baseListener)
 
static int getDebugOutputLevel (void)
 
static bool setDebugOutputLevel (int debugLevel)
 
static const LogFormatOptionsgetLogFormatOptions (void)
 
static void setLogFormatOptions (const LogFormatOptions &options)
 

Detailed Description

Optional flags to be used with RaiseEventOptions::setWebFlags() and with various property setters of the MutablePlayer and the MutableRoom class to control the behavior of forwarded HTTP requests.

Please see Webhooks v1.2 for further information.

See also
Webhooks v1.2, RaiseEventOptions::setWebFlags(), MutablePlayer, MutableRoom

Constructor & Destructor Documentation

§ WebFlags()

WebFlags ( nByte  webFlags = 0)

Constructor: Creates a new instance with the specified parameters.

Parameters
webFlagssee setFlags() - optional, defaults to 0.

Member Function Documentation

§ getFlags()

nByte getFlags ( void  ) const
Returns
the currently set flags
See also
setFlags()

§ setFlags()

WebFlags & setFlags ( nByte  webFlags)

Sets the values of all flags at once.

Internally all boolean flags are encoded as bits into a single byte variable. This byte can be retrieved with getFlags() and set with setFlags().

Parameters
webFlags
Returns
a reference to the instance on which it was called to allow for chaining multiple setter calls
See also
getFlags()

§ getHttpForward()

bool getHttpForward ( void  ) const
Returns
the currently set value of the httpWebForward flag
See also
setHttpForward()

§ setHttpForward()

WebFlags & setHttpForward ( bool  httpWebForward)

Sets the value of the httpWebForward flag.

Parameters
httpWebForwardtrue or false
Returns
a reference to the instance on which it was called to allow for chaining multiple setter calls
See also
getHttpForward()

§ getSendAuthCookie()

bool getSendAuthCookie ( void  ) const
Returns
the currently set value of the sendAuthCookie flag
See also
setSendAuthCookie()

§ setSendAuthCookie()

WebFlags & setSendAuthCookie ( bool  sendAuthCookie)

Sets the value of the sendAuthCookie flag.

Parameters
sendAuthCookietrue or false
Returns
a reference to the instance on which it was called to allow for chaining multiple setter calls
See also
getSendAuthCookie()

§ getSendSync()

bool getSendSync ( void  ) const
Returns
the currently set value of the sendSync flag
See also
setSendSync()

§ setSendSync()

WebFlags & setSendSync ( bool  sendSync)

Sets the value of the sendSync flag.

Parameters
sendSynctrue or false
Returns
a reference to the instance on which it was called to allow for chaining multiple setter calls
See also
getSendSync()

§ getSendState()

bool getSendState ( void  ) const
Returns
the currently set value of the sendState flag
See also
setSendState()

§ setSendState()

WebFlags & setSendState ( bool  sendState)

Sets the value of the sendState flag.

Parameters
sendStatetrue or false
Returns
a reference to the instance on which it was called to allow for chaining multiple setter calls
See also
getSendState()

§ toString()

JString & toString ( Common::JString retStr,
bool  withTypes = false 
) const
virtual
Remarks
The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.
Parameters
retStrreference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypesset to true, to include type information in the generated string
Returns
a JString representation of the instance and its contents for debugging purposes.

Implements ToString.