Photon Plugins API Documentation v5.0RC1

Properties | List of all members
Photon.Hive.Plugin.SendParameters Struct Reference

The struct contains the parameters for Photon.SocketServer.PeerBase.SendOperationResponse(Photon.SocketServer.OperationResponse,Photon.SocketServer.SendParameters), Photon.SocketServer.PeerBase.SendEvent(Photon.SocketServer.IEventData,Photon.SocketServer.SendParameters) and Photon.SocketServer.ServerToServer.S2SPeerBase.SendOperationRequest(Photon.SocketServer.OperationRequest,Photon.SocketServer.SendParameters) and contains the info about incoming data at Photon.SocketServer.PeerBase.OnOperationRequest(Photon.SocketServer.OperationRequest,Photon.SocketServer.SendParameters), Photon.SocketServer.ServerToServer.S2SPeerBase.OnEvent(Photon.SocketServer.IEventData,Photon.SocketServer.SendParameters) and Photon.SocketServer.ServerToServer.S2SPeerBase.OnOperationResponse(Photon.SocketServer.OperationResponse,Photon.SocketServer.SendParameters). More...

Properties

byte ChannelId [get, set]
 Gets or sets the channel id for the udp protocol. More...
 
bool Encrypted [get, set]
 Gets or sets a value indicating whether the data is sent encrypted. More...
 
bool Flush [get, set]
 Gets or sets a value indicating whether to flush all queued data with the next send. This overrides the configured send delay. More...
 
bool Unreliable [get, set]
 Gets or sets a value indicating whether to send the data unreliable. If the DeliveryMode is set this value is ignored More...
 
PluginDeliveryModeDeliveryMode [get, set]
 Gets or sets a value indicating whether to send the data sequenced or unsequenced and reliable or unreliable. If this value is set the Unreliable flag is ignored. More...
 

Detailed Description

The struct contains the parameters for Photon.SocketServer.PeerBase.SendOperationResponse(Photon.SocketServer.OperationResponse,Photon.SocketServer.SendParameters), Photon.SocketServer.PeerBase.SendEvent(Photon.SocketServer.IEventData,Photon.SocketServer.SendParameters) and Photon.SocketServer.ServerToServer.S2SPeerBase.SendOperationRequest(Photon.SocketServer.OperationRequest,Photon.SocketServer.SendParameters) and contains the info about incoming data at Photon.SocketServer.PeerBase.OnOperationRequest(Photon.SocketServer.OperationRequest,Photon.SocketServer.SendParameters), Photon.SocketServer.ServerToServer.S2SPeerBase.OnEvent(Photon.SocketServer.IEventData,Photon.SocketServer.SendParameters) and Photon.SocketServer.ServerToServer.S2SPeerBase.OnOperationResponse(Photon.SocketServer.OperationResponse,Photon.SocketServer.SendParameters).


Property Documentation

◆ ChannelId

byte Photon.Hive.Plugin.SendParameters.ChannelId
getset

Gets or sets the channel id for the udp protocol.

◆ DeliveryMode

PluginDeliveryMode? Photon.Hive.Plugin.SendParameters.DeliveryMode
getset

Gets or sets a value indicating whether to send the data sequenced or unsequenced and reliable or unreliable. If this value is set the Unreliable flag is ignored.

◆ Encrypted

bool Photon.Hive.Plugin.SendParameters.Encrypted
getset

Gets or sets a value indicating whether the data is sent encrypted.

◆ Flush

bool Photon.Hive.Plugin.SendParameters.Flush
getset

Gets or sets a value indicating whether to flush all queued data with the next send. This overrides the configured send delay.

◆ Unreliable

bool Photon.Hive.Plugin.SendParameters.Unreliable
getset

Gets or sets a value indicating whether to send the data unreliable. If the DeliveryMode is set this value is ignored