Class Config
Inheritance
Inherited Members
Show
Syntax
public class Config
Fields
MaxConnections
Max concurrent connections server will accept
Declaration
public int MaxConnections
SendRejectIfUnconnectedPacketIsInvalid
Send reject if a new (unconnected) endPoint sends an invalid packet. If this is false then invalid packets will be ignored Setting this to true is useful if the EndPoint/Socket has a stateful connection and can listen for reject to close the connection
Declaration
public bool SendRejectIfUnconnectedPacketIsInvalid
ConnectAttemptInterval
How often connect attempt message will be re-sent if server does not reply
Declaration
public float ConnectAttemptInterval
MaxConnectAttempts
How many times attempt to connect before giving up
Declaration
public int MaxConnectAttempts
KeepAliveInterval
how long after previous send before sending keep alive message Keep alive is to stop connection from timing out keep alive is sent over unreliable so this interval should be low enough so that does not timeout if some unreliable packets are missed
Declaration
public float KeepAliveInterval
TimeoutDuration
how long without a message before disconnecting connection
Declaration
public float TimeoutDuration
key
Key sent with connection message (defaults to Major version of assmebly) Used to validate that server and client are same application/version NOTE: key will be ASCII encoded
Declaration
public string key
DisconnectDuration
How long after disconnect before connection is fully removed from Peer
Declaration
public float DisconnectDuration
BufferPoolStartSize
How many buffers to create at start
Declaration
public int BufferPoolStartSize
BufferPoolMaxSize
max number of buffers allowed to be stored in pool buffers over this limit will be left for GC
Declaration
public int BufferPoolMaxSize
TimeBeforeEmptyAck
how long after last send to send ack without a message
Declaration
public float TimeBeforeEmptyAck
ReceivesBeforeEmptyAck
How many receives before sending an empty ack this is so that acks are still sent even if receives many message before replying
Declaration
public int ReceivesBeforeEmptyAck
EmptyAckLimit
How many empty acks to send via Send enough acks that there is a high chances that 1 of them reaches other size Empty Ack count resets after receives new message
Declaration
public int EmptyAckLimit
MaxReliablePacketsInSendBufferPerConnection
How many packets can exist it ring buffers for Ack and Reliable system This value wont count null packets so can be set lower than 's value to limit actual number of packets waiting to be acked Example: (max=2000) (MTU=1200) (connections=100) => 240MB
Declaration
public int MaxReliablePacketsInSendBufferPerConnection
SequenceSize
Bit size of sequence used for AckSystem this value also determines the size of ring buffers for Ack and Reliable system Max of 16
Declaration
public int SequenceSize
MaxReliableFragments
How many fragments large reliable message can be split into if set to 0 then messages over will not be allowed to be sent max value is 255
Declaration
public int MaxReliableFragments
DisableReliableLayer
Enable if the Socket you are using has its own Reliable layer. For example using Websocket, which is TCP.
Declaration
public bool DisableReliableLayer
Methods
Create(PeerConfigProfile)
Declaration
public static Config Create(PeerConfigProfile profile)
Parameters
| Type | Name | Description |
|---|---|---|
| Mirage.SocketLayer.PeerConfigProfile | profile |
Returns
| Type | Description |
|---|---|
| Mirage.SocketLayer.Config |
RawUdp()
Declaration
public static Config RawUdp()
Returns
| Type | Description |
|---|---|
| Mirage.SocketLayer.Config |
WebSocket()
Declaration
public static Config WebSocket()
Returns
| Type | Description |
|---|---|
| Mirage.SocketLayer.Config |
StatefulUdp()
Declaration
public static Config StatefulUdp()
Returns
| Type | Description |
|---|---|
| Mirage.SocketLayer.Config |