UnityEngine.UNETModule

Defines parameters of channels.

UnderlyingModel.MemDoc.MemDocModel.

Requested type of quality of service (default Unreliable). Copy constructor.

UnderlyingModel.MemDoc.MemDocModel.

Requested type of quality of service (default Unreliable). Copy constructor.

UnderlyingModel.MemDoc.MemDocModel.

Requested type of quality of service (default Unreliable). Copy constructor.

Channel quality of service.

Defines size of the buffer holding reliable messages, before they will be acknowledged.

Ack buffer can hold 128 messages.

Ack buffer can hold 32 messages.

Ack buffer can hold 64 messages.

Ack buffer can hold 96 messages.

This class defines parameters of connection between two peers, this definition includes various timeouts and sizes as well as channel configuration.

Defines the duration in milliseconds that the receiver waits for before it sends an acknowledgement back without waiting for any data payload. Default value = 33. Network clients that send data to a server may do so using many different quality of service (QOS) modes, some of which (reliable modes) expect the server to send back acknowledgement of receipt of data sent. Servers must periodically acknowledge data packets received over channels with reliable QOS modes by sending packets containing acknowledgement data (also known as "acks") back to the client. If the server were to send an acknowledgement immediately after receiving each packet from the client there would be significant overhead (the acknowledgement is a 32 or 64 bit integer, which is very small compared to the whole size of the packet which also contains the IP and the UDP header). AckDelay allows the server some time to accumulate a list of received reliable data packets to acknowledge, and decreases traffic overhead by combining many acknowledgements into a single packet.

Determines the size of the buffer used to store reliable messages that are waiting for acknowledgement. It can be set to Acks32, Acks64, Acks96, or Acks128. Depends of this setting buffer can hold 32, 64, 96, or 128 messages. Default value = Ack32. Messages sent on reliable quality of service channels are stored in a special buffer while they wait for acknowledgement from the peer. This buffer can be either 32, 64, 96 or 128 positions long. It is recommended to begin with this value set to Ack32, which defines a buffer up to 32 messages in size. If you receive NoResources errors often when you send reliable messages, change this value to the next possible size.

Adds a new channel to the configuration and returns the unique id of that channel. Channels are logical delimiters of traffic between peers. Every time you send data to a peer, you should use two ids: connection id and channel id. Channels are not only logically separate traffic but could each be configured with a different quality of service (QOS). In the example below, a configuration is created containing two channels with Unreliable and Reliable QOS types. This configuration is then used for sending data.

Add new channel to configuration. Channel id, user can use this id to send message via this channel.

Defines the timeout in milliseconds after which messages sent via the AllCost channel will be re-sent without waiting for acknowledgement. Default value = 20 ms. AllCost delivery quality of service (QOS) is a special QOS for delivering game-critical information, such as when the game starts, or when bullets are shot. Due to packets dropping, sometimes reliable messages cannot be delivered and need to be re-sent. Reliable messages will re-sent after RTT+Delta time, (RTT is round trip time) where RTT is a dynamic value and can reach couple of hundred milliseconds. For the AllCost delivery channel this timeout can be user-defined to force game critical information to be re-sent.

Defines, when multiplied internally by InitialBandwidth, the maximum bandwidth that can be used under burst conditions.

(Read Only) The number of channels in the current configuration.

The list of channels belonging to the current configuration. Note: any ConnectionConfig passed as a parameter to a function in Unity Multiplayer is deep copied (that is, an entirely new copy is made, with no references to the original).

Timeout in ms which library will wait before it will send another connection request.

Will create default connection config or will copy them from another.

Connection config.

Will create default connection config or will copy them from another.

Connection config.

Defines the timeout in milliseconds before a connection is considered to have been disconnected. Default value = 2000. Unity Multiplayer defines conditions under which a connection is considered as disconnected. Disconnection can happen for the following reasons: (1) A disconnection request was received. (2) The connection has not received any traffic at all for a time longer than DisconnectTimeout (Note that live connections receive regular keep-alive packets, so in this case "no traffic" means not only no user traffic but also absence of any keep-alive traffic as well). (3) Flow control determines that the time between sending packets is longer than DisconnectTimeout. Keep-alive packets are regularly delivered from peers and contain statistical information. This information includes values of packet loss due to network and peer overflow conditions. Setting NetworkDropThreshold and OverflowDropThreshold defines thresholds for flow control which can decrease packet frequency. When the time before sending the next packet is longer than DisconnectTimeout, the connection will be considered as disconnected and a disconnect event is received.

Defines the fragment size for fragmented messages (for QOS: ReliableFragmented and UnreliableFragmented). Default value = 500. Under fragmented quality of service modes, the original message is split into fragments (up to 64) of up to FragmentSize bytes each. The fragment size depends on the frequency and size of reliable messages sent. Each reliable message potentially could be re-sent, so you need to choose a fragment size less than the remaining free space in a UDP packet after retransmitted reliable messages are added to the packet. For example, if Networking.ConnectionConfig.PacketSize is 1440 bytes, and a reliable message's average size is 200 bytes, it would be wise to set this parameter to 900 – 1000 bytes.

Return the QoS set for the given channel or throw an out of range exception.

Index in array. Channel QoS.

Gets or sets the bandwidth in bytes per second that can be used by Unity Multiplayer. No traffic over this limit is allowed. Unity Multiplayer may internally reduce the bandwidth it uses due to flow control. The default value is 1500MB/sec (1,536,000 bytes per second). The default value is intentionally a large number to allow all traffic to pass without delay.

Defines the maximum number of small reliable messages that can be included in one combined message. Default value = 10. Since each message sent to a server contains IP information and a UDP header, duplicating this information for every message sent can be inefficient in the case where there are many small messages being sent frequently. Many small reliable messages can be combined into one longer reliable message, saving space in the waiting buffer. Unity Multiplayer will automatically combine up to MaxCombinedReliableMessageCount small messages into one message. To qualify as a small message, the data payload of the message should not be greater than MaxCombinedReliableMessageSize.

Defines the maximum size in bytes of a reliable message which is considered small enough to include in a combined message. Default value = 100. Since each message sent to a server contains IP information and a UDP header, duplicating this information for every message sent can be inefficient in the case where there are many small messages being sent frequently. Many small reliable messages can be combined into one longer reliable message, saving space in the waiting buffer. Unity Multiplayer will automatically combine up to MaxCombinedReliableMessageCount small messages into one message. To qualify as a small message, the data payload of the message should not be greater than MaxCombinedReliableMessageSize.

Defines the maximum number of times Unity Multiplayer will attempt to send a connection request without receiving a response before it reports that it cannot establish a connection. Default value = 10.

Defines maximum number of messages that can be held in the queue for sending. Default value = 128. This buffer serves to smooth spikes in traffic and decreases network jitter. If the queue is full, a NoResources error will result from any calls to Send(). Setting this value greater than around 300 is likely to cause significant delaying of message delivering and can make game unplayable.

Defines minimum time in milliseconds between sending packets. This duration may be automatically increased if required by flow control. Default value = 10. When Send() is called, Unity Multiplayer won’t send the message immediately. Instead, once every SendTimeout milliseconds each connection is checked to see if it has something to send. While initial and minimal send timeouts can be set, these may be increased internally due to network conditions or buffer overflows.

Defines the percentage (from 0 to 100) of packets that need to be dropped due to network conditions before the SendUpdate timeout is automatically increased (and send rate is automatically decreased). Default value = 5. To avoid receiver overflow, Unity Multiplayer supports flow control. Each ping packet sent between connected peers contains two values: (1) Packets lost due to network conditions. (2) Packets lost because the receiver does not have free space in its incoming buffers. Like OverflowDropThreshold, both values are reported in percent. Use NetworkDropThreshold and OverflowDropThreshold to set thresholds for these values. If a value reported in the ping packet exceeds the corresponding threshold, Unity Multiplayer increases the sending timeout for packets up to a maximum value of DisconnectTimeout. Note: wireless networks usually exhibit 5% or greater packet loss. For wireless networks it is advisable to use a NetworkDropThreshold of 40-50%.

Defines the percentage (from 0 to 100) of packets that need to be dropped due to lack of space in internal buffers before the SendUpdate timeout is automatically increased (and send rate is automatically decreased). Default value = 5. To avoid receiver overflow, Unity Multiplayer supports flow control. Each ping packet sent between connected peers contains two values: (1) Packets lost due to network conditions. (2) Packets lost because the receiver does not have free space in its incoming buffers. Like NetworkDropThreshold, both values are reported in percent. Use NetworkDropThreshold and OverflowDropThreshold to set thresholds for these values. If a value reported in the ping packet exceeds the corresponding threshold, Unity Multiplayer increases the sending timeout for packets up to a maximum value of DisconnectTimeout. Note: wireless networks usually exhibit 5% or greater packet loss. For wireless networks it is advisable to use a NetworkDropThreshold of 40-50%.

Defines maximum packet size (in bytes) (including payload and all header). Packet can contain multiple messages inside. Default value = 1500. Note that this default value is suitable for local testing only. Usually you should change this value; a recommended setting for PC or mobile is 1470. For games consoles this value should probably be less than ~1100. Wrong size definition can cause packet dropping.

Defines the duration in milliseconds between keep-alive packets, also known as pings. Default value = 500. The ping frequency should be long enough to accumulate good statistics and short enough to compare with DisconnectTimeout. A good guideline is to have more than 3 pings per disconnect timeout, and more than 5 messages per ping. For example, with a DisconnectTimeout of 2000ms, a PingTimeout of 500ms works well.

Defines the maximum wait time in milliseconds before the "not acknowledged" message is re-sent. Default value = 1200. It does not make a lot of sense to wait for acknowledgement forever. This parameter sets an upper time limit at which point reliable messages are re-sent.

Gets or sets the delay in milliseconds after a call to Send() before packets are sent. During this time, new messages may be combined in queued packets. Default value: 10ms.

Defines the path to the file containing the certification authority (CA) certificate for WebSocket via SSL communication.

Defines path to SSL certificate file, for WebSocket via SSL communication.

Defines the path to the file containing the private key for WebSocket via SSL communication.

Defines the size in bytes of the receiving buffer for UDP sockets. It is useful to set this parameter equal to the maximum size of a fragmented message. Default value is OS specific (usually 8kb).

When starting a server use protocols that make use of platform specific optimisations where appropriate rather than cross-platform protocols. (Sony consoles only).

Validate parameters of connection config. Will throw exceptions if parameters are incorrect.

WebSocket only. Defines the buffer size in bytes for received frames on a WebSocket host. If this value is 0 (the default), a 4 kilobyte buffer is used. Any other value results in a buffer of that size, in bytes. WebSocket message fragments are called "frames". A WebSocket host has a buffer to store incoming message frames. Therefore this buffer should be set to the largest legal frame size supported. If an incoming frame exceeds the buffer size, no error is reported. However, the buffer will invoke the user callback in order to create space for the overflow.

Create configuration for network simulator; You can use this class in editor and developer build only.

Will create object describing network simulation parameters.

Minimal simulation delay for outgoing traffic in ms. Average simulation delay for outgoing traffic in ms. Minimal simulation delay for incoming traffic in ms. Average simulation delay for incoming traffic in ms. Probability of packet loss 0 <= p <= 1.

Destructor.

Defines global paramters for network library.

Create new global config object.

Defines how many hosts you can use. Default Value = 16. Max value = 128.

Deprecated. Defines maximum delay for network simulator. See Also: MaxTimerTimeout.

Defines maximum possible packet size in bytes for all network connections.

Defines the maximum timeout in milliseconds for any configuration. The default value is 12 seconds (12000ms).

Deprecated. Defines the minimal timeout for network simulator. You cannot set up any delay less than this value. See Also: MinTimerTimeout.

Defines the minimum timeout in milliseconds recognised by the system. The default value is 1 ms.

This property determines the initial size of the queue that holds messages received by Unity Multiplayer before they are processed.

Defines the initial size of the send queue. Messages are placed in this queue ready to be sent in packets to their destination.

Defines reactor model for the network library.

Defines (1) for select reactor, minimum time period, when system will check if there are any messages for send (2) for fixrate reactor, minimum interval of time, when system will check for sending and receiving messages.

Defines how many worker threads are available to handle incoming and outgoing messages.

Class defines network topology for host (socket opened by Networking.NetworkTransport.AddHost function). This topology defines: (1) how many connection with default config will be supported and (2) what will be special connections (connections with config different from default).

Add special connection to topology (for example if you need to keep connection to standalone chat server you will need to use this function). Returned id should be use as one of parameters (with ip and port) to establish connection to this server.

Connection config for special connection. Id of this connection. You should use this id when you call Networking.NetworkTransport.Connect.

Create topology.

Default config. Maximum default connections.

Defines config for default connections in the topology.

Return reference to special connection config. Parameters of this config can be changed.

Config id. Connection config.

Defines how many connection with default config be permitted.

Defines the maximum number of messages that each host can hold in its pool of received messages. The default size is 128.

Defines the maximum number of messages that each host can hold in its pool of messages waiting to be sent. The default size is 128.

List of special connection configs.

Returns count of special connection added to topology.

Details about a UNET MatchMaker match.

The binary access token this client uses to authenticate its session for future commands.

IP address of the host of the match,.

The numeric domain for the match.

The unique ID of this match.

NodeID for this member client in the match.

Port of the host of the match.

This flag indicates whether or not the match is using a Relay server.

A class describing the match information as a snapshot at the time the request was processed on the MatchMaker.

The average Elo score of the match.

The current number of players in the match.

The collection of direct connect info classes describing direct connection information supplied to the MatchMaker.

The NodeID of the host for this match.

Describes if the match is private. Private matches are unlisted in ListMatch results.

The collection of match attributes on this match.

The maximum number of players this match can grow to.

The text name for this match.

The network ID for this match.

A class describing one member of a match and what direct connect information other clients have supplied.

The host priority for this direct connect info. Host priority describes the order in which this match member occurs in the list of clients attached to a match.

NodeID of the match member this info refers to.

The private network address supplied for this direct connect info.

The public network address supplied for this direct connect info.

A component for communicating with the Unity Multiplayer Matchmaking service.

The base URI of the MatchMaker that this NetworkMatch will communicate with.

A delegate that can handle MatchMaker responses that return basic response types (generally only indicating success or failure and extended information if a failure did happen).

Indicates if the request succeeded. A text description of the failure if success is false.

Use this function to create a new match. The client which calls this function becomes the host of the match.

The text string describing the name for this match. When creating a match, the matchmaker will use either this value, or the maximum size you have configured online at https:multiplayer.unity3d.com, whichever is lower. This way you can specify different match sizes for a particular game, but still maintain an overall size limit in the online control panel. A bool indicating if this match should be available in NetworkMatch.ListMatches results. A text string indicating if this match is password protected. If it is, all clients trying to join this match must supply the correct match password. The optional public client address. This value is stored on the matchmaker and given to clients listing matches. It is intended to be a network address for connecting to this client directly over the internet. This value will only be present if a publicly available address is known, and direct connection is supported by the matchmaker. The optional private client address. This value is stored on the matchmaker and given to clients listing matches. It is intended to be a network address for connecting to this client directly on a local area network. This value will only be present if direct connection is supported by the matchmaker. This may be an empty string and it will not affect the ability to interface with matchmaker or use relay server. The Elo score for the client hosting the match being created. If this number is set on all clients to indicate relative skill level, this number is used to return matches ordered by those that are most suitable for play given a listing player's skill level. This may be 0 on all clients, which would disable any Elo calculations in the MatchMaker. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback to be called when this function completes. This will be called regardless of whether the function succeeds or fails. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

Response delegate containing basic information plus a data member. This is used on a subset of MatchMaker callbacks that require data passed in along with the success/failure information of the call itself.

Indicates if the request succeeded. If success is false, this will contain a text string indicating the reason. The generic passed in containing data required by the callback. This typically contains data returned from a call to the service backend.

This function is used to tell MatchMaker to destroy a match in progress, regardless of who is connected.

The NetworkID of the match to terminate. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback to be called when the request completes. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

A function to allow an individual client to be dropped from a match.

The NetworkID of the match the client to drop belongs to. The NodeID of the client to drop inside the specified match. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback to invoke when the request completes. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

The function used to tell MatchMaker the current client wishes to join a specific match.

The NetworkID of the match to join. This is found through calling NetworkMatch.ListMatches and picking a result from the returned list of matches. The password of the match. Leave empty if there is no password for the match, and supply the text string password if the match was configured to have one of the NetworkMatch.CreateMatch request. The optional public client address. This value will be stored on the matchmaker and given to other clients listing matches. You should send this value if you want your players to be able to connect directly with each other over the internet. Alternatively you can pass an empty string and it will not affect the ability to interface with matchmaker or use relay server. The optional private client address. This value will be stored on the matchmaker and given to other clients listing matches. You should send this value if you want your players to be able to connect directly with each other over a Local Area Network. Alternatively you can pass an empty string and it will not affect the ability to interface with matchmaker or use relay server. The Elo score for the client joining the match being created. If this number is set on all clients to indicate relative skill level, this number is used to return matches ordered by those that are most suitable for play given a listing player's skill level. This may be 0 on all clients, which would disable any Elo calculations in the MatchMaker. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback to be invoked when this call completes. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

The function to list ongoing matches in the MatchMaker.

The current page to list in the return results. The size of the page requested. This determines the maximum number of matches contained in the list of matches passed into the callback. The text string name filter. This is a partial wildcard search against match names that are currently active, and can be thought of as matching equivalent to *<matchNameFilter>* where any result containing the entire string supplied here will be in the result set. Boolean that indicates if the response should contain matches that are private (meaning matches that are password protected). The Elo score target for the match list results to be grouped around. If used, this should be set to the Elo level of the client listing the matches so results will more closely match that player's skill level. If not used this can be set to 0 along with all other Elo refereces in funcitons like NetworkMatch.CreateMatch or NetworkMatch.JoinMatch. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback invoked when this call completes on the MatchMaker. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

This function allows the caller to change attributes on a match in progress.

The NetworkID of the match to set attributes on. A bool indicating whether the match should be listed in NetworkMatch.ListMatches results after this call is complete. The request domain for this request. Only requests in the same domain can interface with each other. For example if a NetworkMatch.CreateMatch is made with domain 1, only ListMatches that also specify domain 1 will find that match. Use this value to silo different (possibly incompatible) client versions. The callback invoked after the call has completed, indicating if it was successful or not. This function is asynchronous and will complete at some point in the future, when the coroutine has finished communicating with the service backend.

This method is deprecated. Please instead log in through the editor services panel and setup the project under the Unity Multiplayer section. This will populate the required infomation from the cloud site automatically.

Deprecated, see description.

Possible Networking.NetworkTransport errors.

Not a data message.

The Networking.ConnectionConfig does not match the other endpoint.

The address supplied to connect to was invalid or could not be resolved.

The message is too long to fit the buffer.

Not enough resources are available to process this request.

The operation completed successfully.

Connection timed out.

This error will occur if any function is called with inappropriate parameter values.

The protocol versions are not compatible. Check your library versions.

The specified channel doesn't exist.

The specified connectionId doesn't exist.

The specified host not available.

Operation is not supported.

Event that is returned when calling the Networking.NetworkTransport.Receive and Networking.NetworkTransport.ReceiveFromHost functions.

Broadcast discovery event received. To obtain sender connection info and possible complimentary message from them, call Networking.NetworkTransport.GetBroadcastConnectionInfo() and Networking.NetworkTransport.GetBroadcastConnectionMessage() functions.

Connection event received. Indicating that a new connection was established.

Data event received. Indicating that data was received.

Disconnection event received.

No new event was received.

Transport Layer API.

Creates a host based on Networking.HostTopology.

The Networking.HostTopology associated with the host. Port to bind to (when 0 is selected, the OS will choose a port at random). IP address to bind to. Returns the ID of the host that was created.

Create a host and configure them to simulate Internet latency (works on Editor and development build only).

The Networking.HostTopology associated with the host. Minimum simulated delay in milliseconds. Maximum simulated delay in milliseconds. Port to bind to (when 0 is selected, the OS will choose a port at random). IP address to bind to. Returns host ID just created.

Created web socket host.

Port to bind to. The Networking.HostTopology associated with the host. IP address to bind to. Web socket host id.

Created web socket host.

Port to bind to. The Networking.HostTopology associated with the host. IP address to bind to. Web socket host id.

Tries to establish a connection to another peer.

Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). IPv4 address of the other peer. Port of the other peer. Set to 0 in the case of a default connection. Error (can be cast to Networking.NetworkError for more information). A unique connection identifier on success (otherwise zero).

Create dedicated connection to Relay server.

Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). IPv4 address of the relay. Port of the relay. GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.CreateMatch and using the Networking.Match.MatchInfo.networkId. GUID for the source, can be retrieved by calling Utility.GetSourceID. Error (can be cast to Networking.NetworkError for more information). Slot ID for this user, retrieved by calling Networking.Match.NetworkMatch.CreateMatch and using the Networking.Match.MatchInfo.nodeId.

Try to establish connection to other peer, where the peer is specified using a C# System.EndPoint.

Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). Error (can be cast to Networking.NetworkError for more information). A valid System.EndPoint. Set to 0 in the case of a default connection. A unique connection identifier on success (otherwise zero).

Create a connection to another peer in the Relay group.

Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). IP address of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.address. Port of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.port. Set to 0 in the case of a default connection. ID of the remote peer in relay. GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.networkId. GUID for the source, can be retrieved by calling Utility.GetSourceID. Error (can be cast to Networking.NetworkError for more information). Slot ID reserved for the user, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.nodeId. Allowed peak bandwidth (peak bandwidth = factor*bytesPerSec, recommended value is 2.0) If data has not been sent for a long time, it is allowed to send more data, with factor 2 it is allowed send 2*bytesPerSec bytes per sec. Average bandwidth (bandwidth will be throttled on this level). A unique connection identifier on success (otherwise zero).

Create a connection to another peer in the Relay group.

Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). IP address of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.address. Port of the peer, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.port. Set to 0 in the case of a default connection. ID of the remote peer in relay. GUID for the relay match, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.networkId. GUID for the source, can be retrieved by calling Utility.GetSourceID. Error (can be cast to Networking.NetworkError for more information). Slot ID reserved for the user, retrieved by calling Networking.Match.NetworkMatch.JoinMatch and using the Networking.Match.MatchInfo.nodeId. Allowed peak bandwidth (peak bandwidth = factor*bytesPerSec, recommended value is 2.0) If data has not been sent for a long time, it is allowed to send more data, with factor 2 it is allowed send 2*bytesPerSec bytes per sec. Average bandwidth (bandwidth will be throttled on this level). A unique connection identifier on success (otherwise zero).

Connect with simulated latency.

Host ID associated with this connection (Retrieved when calling Networking.NetworkTransport.AddHost). IPv4 address of the other peer. Port of the other peer. Set to 0 in the case of a default connection. Error (can be cast to Networking.NetworkError for more information). A Networking.ConnectionSimulatorConfig defined for this connection. A unique connection identifier on success (otherwise zero).

Send a disconnect signal to the connected peer and close the connection. Poll Networking.NetworkTransport.Receive() to be notified that the connection is closed. This signal is only sent once (best effort delivery). If this packet is dropped for some reason, the peer closes the connection by timeout.

Host ID associated with this connection. The connection ID of the connection you want to close. Error (can be cast to Networking.NetworkError for more information).

This will disconnect the host and disband the group. DisconnectNetworkHost can only be called by the group owner on the relay server.

Host ID associated with this connection. Error (can be cast to Networking.NetworkError for more information).

Finalizes sending of a message to a group of connections. Only one multicast message at a time is allowed per host.

Host ID associated with this connection (retrieved when calling Networking.NetworkTransport.AddHost). Error (can be cast to Networking.NetworkError for more information).

Returns size of reliable buffer.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Size of ack buffer.

The Unity Multiplayer spawning system uses assetIds to identify what remote objects to spawn. This function allows you to get the assetId for the prefab associated with an object.

Target GameObject to get assetId for. The assetId of the game object's prefab.

After Networking.NetworkTransport.Receive() returns Networking.NetworkEventType.BroadcastEvent, this function will return the connection information of the broadcast sender. This information can then be used for connecting to the broadcast sender.

ID of the broadcast receiver. IPv4 address of broadcast sender. Port of broadcast sender. Error (can be cast to Networking.NetworkError for more information).

After Networking.NetworkTransport.Receive() returns Networking.NetworkEventType.BroadcastEvent, this function returns a complimentary message from the broadcast sender.

ID of broadcast receiver. Message buffer provided by caller. Buffer size. Received size (if received size > bufferSize, corresponding error will be set). Error (can be cast to Networking.NetworkError for more information).

Returns the connection parameters for the specified connectionId. These parameters can be sent to other users to establish a direct connection to this peer. If this peer is connected to the host via Relay, the Relay-related parameters are set.

Host ID associated with this connection. ID of connection. IP address. Port. Relay network guid. Error (can be cast to Networking.NetworkError for more information). Destination slot id.

Returns the number of unread messages in the read-queue.

Returns the total number of messages still in the write-queue.

Return the round trip time for the given connectionId.

Error (can be cast to Networking.NetworkError for more information). Host ID associated with this connection. ID of the connection. Current round trip time in ms.

Returns the number of received messages waiting in the queue for processing.

Host ID associated with this queue. Error code. Cast this value to Networking.NetworkError for more information. The number of messages in the queue.

Returns how many packets have been received from start for connection.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). The absolute number of packets received since the connection was established.

Returns how many packets have been received from start. (from Networking.NetworkTransport.Init call).

Packets count received from start for all hosts.

How many packets have been dropped due lack space in incoming queue (absolute value, countinf from start).

Dropping packet count.

Returns how many incoming packets have been lost due transmitting (dropped by network).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). The absolute number of packets that have been lost since the connection was established.

Gets the currently-allowed network bandwidth in bytes per second. The value returned can vary because bandwidth can be throttled by flow control. If the bandwidth is throttled to zero, the connection is disconnected.ted.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Currently-allowed bandwidth in bytes per second.

Function returns time spent on network I/O operations in microseconds.

Time in micro seconds.

Return the total number of packets that has been lost.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information).

Get a network timestamp. Can be used in your messages to investigate network delays together with Networking.GetRemoteDelayTimeMS.

Timestamp.

Returns how much raw data (in bytes) have been sent from start for all hosts (from Networking.NetworkTransport.Init call).

Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for all hosts.

Returns how much raw data (in bytes) have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for connection.

Returns how much raw data (in bytes) have been sent from start for the host (from call Networking.NetworkTransport.AddHost).

ID of the host. Error (can be cast to Networking.NetworkError for more information). Total data (user payload, protocol specific data, ip and udp headers) (in bytes) sent from start for the host.

Returns how many messages have been sent from start (from Networking.NetworkTransport.Init call).

Messages count sent from start (from call Networking.NetworkTransport.Init) for all hosts.

Returns how many packets have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Messages count sending from start for connection.

Returns how many messages have been sent from start for host (from call Networking.NetworkTransport.AddHost).

ID of the host. Error (can be cast to Networking.NetworkError for more information). Messages count sending from start for the host.

Returns the number of messages waiting in the outgoing message queue to be sent.

Host ID associated with this queue. Error code. Cast this value to Networking.NetworkError for more information. The number of messages waiting in the outgoing message queue to be sent.

Returns how many packets have been sent from start (from call Networking.NetworkTransport.Init) for all hosts.

Packets count sent from networking library start (from call Networking.NetworkTransport.Init) for all hosts.

Returns how many packets have been sent for connection from it start (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Packets count sent for connection from it start.

Returns how many packets have been sent for host from it start (from call Networking.NetworkTransport.AddHost).

ID of the host. Error (can be cast to Networking.NetworkError for more information). Count packets have been sent from host start.

Returns the value in percent of the number of sent packets that were dropped by the network and not received by the peer.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). The number of packets dropped by the network in the last ping timeout period expressed as an integer percentage from 0 to 100.

Returns the value in percent of the number of sent packets that were dropped by the peer.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). The number of packets dropped by the peer in the last ping timeout period expressed as an integer percentage from 0 to 100.

Returns how much user payload and protocol system headers (in bytes) have been sent from start (from Networking.NetworkTransport.Init call).

Total payload and protocol system headers (in bytes) sent from start for all hosts.

Returns how much payload and protocol system headers (in bytes) have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Total user payload and protocol system headers (in bytes) sent from start for connection.

Returns how much payload and protocol system headers (in bytes) have been sent from start for the host (from call Networking.NetworkTransport.AddHost).

ID of the host. Error (can be cast to Networking.NetworkError for more information). Total user payload and protocol system headers (in bytes) sent from start for the host.

Returns how much payload (user) bytes have been sent from start (from Networking.NetworkTransport.Init call).

Total payload (in bytes) sent from start for all hosts.

Returns how much payload (user) bytes have been sent from start for connection (from call Networking.NetworkTransport.Connect for active connect or from connection request receiving for passive connect).

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). Total payload (in bytes) sent from start for connection.

Returns how much payload (user) bytes have been sent from start for the host (from call Networking.NetworkTransport.AddHost).

ID of the host. Error (can be cast to Networking.NetworkError for more information). Total payload (in bytes) sent from start for the host.

Return the current receive rate in bytes per second.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information).

Return the current send rate in bytes per second.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information).

Returns the delay for the timestamp received.

Host ID associated with this connection. ID of the connection. Timestamp delivered from peer. Error (can be cast to Networking.NetworkError for more information).

Deprecated. Use Networking.NetworkTransport.GetNetworkLostPacketNum() instead.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information).

Initializes the NetworkTransport. Should be called before any other operations on the NetworkTransport are done.

Check if the broadcast discovery sender is running.

True if it is running. False if it is not running.

Deprecated.

Function is queueing but not sending messages.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). The channel ID to send on. Buffer containing the data to send. Size of the buffer. True if success.

Called to poll the underlying system for events.

Host ID associated with the event. The connectionID that received the event. The channel ID associated with the event. The buffer that will hold the data received. Size of the buffer supplied. The actual receive size of the data. Error (can be cast to Networking.NetworkError for more information). Type of event returned.

Similar to Networking.NetworkTransport.Receive but will only poll for the provided hostId.

The host ID to check for events. The connection ID that received the event. The channel ID associated with the event. The buffer that will hold the data received. Size of the buffer supplied. The actual receive size of the data. Error (can be cast to Networking.NetworkError for more information). Type of event returned.

Polls the host for the following events: Networking.NetworkEventType.ConnectEvent and Networking.NetworkEventType.DisconnectEvent. Can only be called by the relay group owner.

The host ID to check for events. Error (can be cast to Networking.NetworkError for more information). Type of event returned.

Closes the opened socket, and closes all connections belonging to that socket.

Host ID to remove.

Send data to peer.

Host ID associated with this connection. ID of the connection. The channel ID to send on. Buffer containing the data to send. Size of the buffer. Error (can be cast to Networking.NetworkError for more information).

Add a connection for the multicast send.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information).

Sends messages, previously queued by NetworkTransport.QueueMessageForSending function.

Host ID associated with this connection. ID of the connection. Error (can be cast to Networking.NetworkError for more information). True if hostId and connectioId are valid.

Sets the credentials required for receiving broadcast messages. Should any credentials of a received broadcast message not match, the broadcast discovery message is dropped.

Host ID associated with this broadcast. Key part of the credentials associated with this broadcast. Version part of the credentials associated with this broadcast. Subversion part of the credentials associated with this broadcast. Error (can be cast to Networking.NetworkError for more information).

Used to inform the profiler of network packet statistics.

The ID of the message being reported. Number of message being reported. Number of bytes used by reported messages.

Shut down the NetworkTransport.

Starts sending a broadcasting message in all local subnets.

Host ID which should be reported via broadcast (broadcast receivers will connect to this host). Port used for the broadcast message. Key part of the credentials associated with this broadcast. Version part of the credentials associated with this broadcast. Subversion part of the credentials associated with this broadcast. Complimentary message. This message will delivered to the receiver with the broadcast event. Size of message. Specifies how often the broadcast message should be sent in milliseconds. Error (can be cast to Networking.NetworkError for more information). Return true if broadcasting request has been submitted.

Start to multicast send.

Host ID associated with this connection. The channel ID. Buffer containing the data to send. Size of the buffer. Error (can be cast to Networking.NetworkError for more information).

Stop sending the broadcast discovery message.

Enumeration of all supported quality of service channel modes.

A reliable message that will be re-sent with a high frequency until it is acknowledged.

Each message is guaranteed to be delivered but not guaranteed to be in order.

Each message is guaranteed to be delivered, also allowing fragmented messages with up to 32 fragments per message.

Each message is guaranteed to be delivered in order, also allowing fragmented messages with up to 32 fragments per message.

Each message is guaranteed to be delivered and in order.

A reliable message. Note: Only the last message in the send buffer is sent. Only the most recent message in the receive buffer will be delivered.

An unreliable message. Only the last message in the send buffer is sent. Only the most recent message in the receive buffer will be delivered.

There is no guarantee of delivery or ordering.

There is no guarantee of delivery or ordering, but allowing fragmented messages with up to 32 fragments per message.

There is garantee of ordering, no guarantee of delivery, but allowing fragmented messages with up to 32 fragments per message.

There is no guarantee of delivery and all unordered messages will be dropped. Example: VoIP.

Define how unet will handle network io operation.

Network thread will sleep up to threadawake timeout, after that it will try receive up to maxpoolsize amount of messages and then will try perform send operation for connection whihc ready to send.

Network thread will sleep up to threadawake timeout, or up to receive event on socket will happened. Awaked thread will try to read up to maxpoolsize packets from socket and will try update connections ready to send (with fixing awaketimeout rate).

The AppID identifies the application on the Unity Cloud or UNET servers.

Invalid AppID.

An Enum representing the priority of a client in a match, starting at 0 and increasing.

The Invalid case for a HostPriority. An Invalid host priority is not a valid host.

Describes the access levels granted to this client.

Administration access level, generally describing clearence to perform game altering actions against anyone inside a particular match.

Invalid access level, signifying no access level has been granted/specified.

Access level Owner, generally granting access for operations key to the peer host server performing it's work.

User access level. This means you can do operations which affect yourself only, like disconnect yourself from the match.

Access token used to authenticate a client session for the purposes of allowing or disallowing match operations requested by that client.

Binary field for the actual token.

Accessor to get an encoded string from the m_array data.

Checks if the token is a valid set of data with respect to default values (returns true if the values are not default, does not validate the token is a current legitimate token with respect to the server's auth framework).

Network ID, used for match making.

Invalid NetworkID.

The NodeID is the ID used in Relay matches to track nodes in a network.

The invalid case of a NodeID.

Identifies a specific game instance.

Invalid SourceID.

Networking Utility.

This property is deprecated and does not need to be set or referenced.

Utility function to get this client's access token for a particular network, if it has been set.

Utility function to fetch the program's ID for UNET Cloud interfacing.

Utility function to get the client's SourceID for unique identification.

Utility function that accepts the access token for a network after it's received from the server.

Deprecated; Setting the AppID is no longer necessary. Please log in through the editor and set up the project there.