Photon Bolt Engine API  1.2.9
Public Member Functions | Static Public Member Functions | Properties | List of all members
UdpKit.UdpSessionFilter Class Reference

Used to filter only specific sessions that agree with the desired parameters when joining a session in a random fashion. More...

Public Member Functions

bool Add (string key, object value)
 Adds a filter parameter. More...
 
Dictionary< object, object >.Enumerator GetEnumerator ()
 
bool Remove (string key)
 Removes a filter parameter. More...
 
override string ToString ()
 
 UdpSessionFilter ()
 

Static Public Member Functions

static bool IsValid (object value)
 Test if the object passed as argument is a valid Type to be used as filter parameter More...
 

Properties

UdpSessionFillMode FillMode = UdpSessionFillMode.Fill [get, set]
 Configure the fill mode used to join a session. Default is UdpSessionFillMode.Fill. More...
 
object this[string key] [get, set]
 Index operator to read and write values. More...
 

Detailed Description

Used to filter only specific sessions that agree with the desired parameters when joining a session in a random fashion.

Constructor & Destructor Documentation

◆ UdpSessionFilter()

UdpKit.UdpSessionFilter.UdpSessionFilter ( )
inline

Member Function Documentation

◆ Add()

bool UdpKit.UdpSessionFilter.Add ( string  key,
object  value 
)
inline

Adds a filter parameter.

Returns
true, if the parameter was added, false otherwise.
Parameters
keyParameter Key.
valueParameter Value.

◆ GetEnumerator()

Dictionary<object, object>.Enumerator UdpKit.UdpSessionFilter.GetEnumerator ( )
inline

◆ IsValid()

static bool UdpKit.UdpSessionFilter.IsValid ( object  value)
inlinestatic

Test if the object passed as argument is a valid Type to be used as filter parameter

Parameters
valueValue to be tested
Returns
true if is a valid Type, false otherwise

◆ Remove()

bool UdpKit.UdpSessionFilter.Remove ( string  key)
inline

Removes a filter parameter.

Returns
true, if the parameter was removed, false otherwise.
Parameters
keyParameter Key.

◆ ToString()

override string UdpKit.UdpSessionFilter.ToString ( )
inline

Property Documentation

◆ FillMode

UdpSessionFillMode UdpKit.UdpSessionFilter.FillMode = UdpSessionFillMode.Fill
getset

Configure the fill mode used to join a session. Default is UdpSessionFillMode.Fill.

◆ this[string key]

object UdpKit.UdpSessionFilter.this[string key]
getset

Index operator to read and write values.

Parameters
keyParameter Key
Returns
Parameter Value, if exists