Base NetworkConnection class for server-to-client and client-to-server connection. More...

Inheritance diagram for Mirror.NetworkConnection:

Public Member Functions
void	Send< T > (T message, int channelId=Channels.Reliable)
	Send a NetworkMessage to this connection over the given channel. More...

abstract void	Disconnect ()
	Disconnects this connection. More...

override string	ToString ()

Public Attributes
readonly int	connectionId
	Unique identifier for this connection that is assigned by the transport layer. More...

bool	isAuthenticated
	Flag that indicates the client has been authenticated. More...

object	authenticationData
	General purpose object to hold authentication data, character selection, tokens, etc. More...

bool	isReady
	A server connection is ready after joining the game world. More...

float	lastMessageTime
	Last time a message was received for this connection. Includes system and user messages. More...

Static Public Attributes
const int	LocalConnectionId = 0

Protected Member Functions
Batcher	GetBatchForChannelId (int channelId)

abstract void	SendToTransport (ArraySegment< byte > segment, int channelId=Channels.Reliable)

Static Protected Member Functions
static bool	ValidatePacketSize (ArraySegment< byte > segment, int channelId)

Protected Attributes
Dictionary< int, Batcher >	batches = new Dictionary<int, Batcher>()

Properties
HashSet< NetworkIdentity >	observing `[get]`
	NetworkIdentities that this connection can see More...

abstract string	address `[get]`
	IP address of the connection. Can be useful for game master IP bans etc. More...

NetworkIdentity	identity `[get, set]`
	This connection's main object (usually the player object). More...

HashSet< NetworkIdentity >	clientOwnedObjects `[get]`
	All NetworkIdentities owned by this connection. Can be main player, pets, etc. More...

double	remoteTimeStamp `[get, set]`
	last batch's remote timestamp. not interpolated. useful for NetworkTransform etc. More...

Detailed Description

Base NetworkConnection class for server-to-client and client-to-server connection.

Definition at line 9 of file NetworkConnection.cs.

Member Function Documentation

◆ Disconnect()

abstract void Mirror.NetworkConnection.Disconnect ( )

pure virtual

Disconnects this connection.

Implemented in Mirror.LocalConnectionToClient, Mirror.LocalConnectionToServer, Mirror.NetworkConnectionToClient, and Mirror.NetworkConnectionToServer.

◆ GetBatchForChannelId()

Batcher Mirror.NetworkConnection.GetBatchForChannelId ( int channelId )

protected

Definition at line 87 of file NetworkConnection.cs.

        {
            // get existing or create new writer for the channelId
            Batcher batch;
            if (!batches.TryGetValue(channelId, out batch))
            {
                // get max batch size for this channel
                int threshold = Transport.activeTransport.GetBatchThreshold(channelId);
 
                // create batcher
                batch = new Batcher(threshold);
                batches[channelId] = batch;
            }
            return batch;
        }

◆ Send< T >()

void Mirror.NetworkConnection.Send< T >	(	T	message,
		int	channelId = `Channels.Reliable`
	)

Send a NetworkMessage to this connection over the given channel.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 131 of file NetworkConnection.cs.

                    : struct, NetworkMessage
        {
            using (NetworkWriterPooled writer = NetworkWriterPool.Get())
            {
                // pack message and send allocation free
                MessagePacking.Pack(message, writer);
                NetworkDiagnostics.OnSend(message, channelId, writer.Position, 1);
                Send(writer.ToArraySegment(), channelId);
            }
        }

◆ ValidatePacketSize()

static bool Mirror.NetworkConnection.ValidatePacketSize	(	ArraySegment< byte >	segment,
		int	channelId
	)

staticprotected

Definition at line 108 of file NetworkConnection.cs.

        {
            int max = Transport.activeTransport.GetMaxPacketSize(channelId);
            if (segment.Count > max)
            {
                Debug.LogError($"NetworkConnection.ValidatePacketSize: cannot send packet larger than {max} bytes, was {segment.Count} bytes");
                return false;
            }
 
            if (segment.Count == 0)
            {
                // zero length packets getting into the packet queues are bad.
                Debug.LogError("NetworkConnection.ValidatePacketSize: cannot send zero bytes");
                return false;
            }
 
            // good size
            return true;
        }

Member Data Documentation

◆ authenticationData

object Mirror.NetworkConnection.authenticationData

General purpose object to hold authentication data, character selection, tokens, etc.

Definition at line 27 of file NetworkConnection.cs.

◆ batches

Dictionary<int, Batcher> Mirror.NetworkConnection.batches = new Dictionary<int, Batcher>()

protected

Definition at line 62 of file NetworkConnection.cs.

◆ connectionId

readonly int Mirror.NetworkConnection.connectionId

Unique identifier for this connection that is assigned by the transport layer.

Definition at line 21 of file NetworkConnection.cs.

◆ isAuthenticated

bool Mirror.NetworkConnection.isAuthenticated

Flag that indicates the client has been authenticated.

Definition at line 24 of file NetworkConnection.cs.

◆ isReady

bool Mirror.NetworkConnection.isReady

A server connection is ready after joining the game world.

Definition at line 33 of file NetworkConnection.cs.

◆ lastMessageTime

float Mirror.NetworkConnection.lastMessageTime

Last time a message was received for this connection. Includes system and user messages.

Definition at line 39 of file NetworkConnection.cs.

◆ LocalConnectionId

const int Mirror.NetworkConnection.LocalConnectionId = 0

static

Definition at line 11 of file NetworkConnection.cs.

Property Documentation

◆ address

abstract string Mirror.NetworkConnection.address

get

IP address of the connection. Can be useful for game master IP bans etc.

Definition at line 36 of file NetworkConnection.cs.

36{ get; }

◆ clientOwnedObjects

HashSet<NetworkIdentity> Mirror.NetworkConnection.clientOwnedObjects

get

All NetworkIdentities owned by this connection. Can be main player, pets, etc.

Definition at line 51 of file NetworkConnection.cs.

◆ identity

NetworkIdentity Mirror.NetworkConnection.identity

getset

This connection's main object (usually the player object).

Definition at line 42 of file NetworkConnection.cs.

42{ get; internal set; }

◆ observing

HashSet<NetworkIdentity> Mirror.NetworkConnection.observing

get

NetworkIdentities that this connection can see

Definition at line 16 of file NetworkConnection.cs.

◆ remoteTimeStamp

double Mirror.NetworkConnection.remoteTimeStamp

getset

last batch's remote timestamp. not interpolated. useful for NetworkTransform etc.

Definition at line 71 of file NetworkConnection.cs.

71{ get; internal set; }

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties