Photon .NET Client API 4.1.4.8

Public Attributes | Static Public Attributes | Properties | List of all members
ExitGames.Client.Photon.SendOptions Struct Reference

Wraps up DeliveryMode, Encryption and Channel values for sending operations and messages. More...

Public Attributes

DeliveryMode DeliveryMode
 Chose the DeliveryMode for this operation/message. Defaults to Unreliable. More...
 
bool Encrypt
 If true the operation/message gets encrypted before it's sent. Defaults to false. More...
 
byte Channel
 The Enet channel to send in. Defaults to 0. More...
 

Static Public Attributes

static readonly SendOptions SendReliable = new SendOptions() { Reliability = true }
 Default SendOptions instance for reliable sending. More...
 
static readonly SendOptions SendUnreliable = new SendOptions() { Reliability = false }
 Default SendOptions instance for unreliable sending. More...
 

Properties

bool? Reliability [get, set]
 Sets the DeliveryMode either to true: Reliable or false: Unreliable, overriding any current value. More...
 

Detailed Description

Wraps up DeliveryMode, Encryption and Channel values for sending operations and messages.

Member Data Documentation

◆ Channel

byte ExitGames.Client.Photon.SendOptions.Channel

The Enet channel to send in. Defaults to 0.

Channels in Photon relate to "message channels". Each channel is a sequence of messages.

◆ DeliveryMode

DeliveryMode ExitGames.Client.Photon.SendOptions.DeliveryMode

Chose the DeliveryMode for this operation/message. Defaults to Unreliable.

◆ Encrypt

bool ExitGames.Client.Photon.SendOptions.Encrypt

If true the operation/message gets encrypted before it's sent. Defaults to false.

Before encryption can be used, it must be established. Check PhotonPeer.IsEncryptionAvailable is true.

◆ SendReliable

readonly SendOptions ExitGames.Client.Photon.SendOptions.SendReliable = new SendOptions() { Reliability = true }
static

Default SendOptions instance for reliable sending.

◆ SendUnreliable

readonly SendOptions ExitGames.Client.Photon.SendOptions.SendUnreliable = new SendOptions() { Reliability = false }
static

Default SendOptions instance for unreliable sending.

Property Documentation

◆ Reliability

bool? ExitGames.Client.Photon.SendOptions.Reliability
getset

Sets the DeliveryMode either to true: Reliable or false: Unreliable, overriding any current value.

Use this to conveniently select reliable/unreliable delivery.


The documentation for this struct was generated from the following file: