Nakama.Socket Class Reference

A socket which implements the Nakama realtime API. More...

Inheritance diagram for Nakama.Socket:

Public Member Functions
	Socket ()
	A new socket with default options.
	Socket (ISocketAdapter adapter)
	A new socket with an adapter.
	Socket (string scheme, string host, int port, ISocketAdapter adapter, int sendTimeoutSec=DefaultSendTimeout)
	A new socket with server connection and adapter options.
Task	AcceptPartyMemberAsync (string partyId, IUserPresence presence)
	Accept a party member's request to join the party. Parameters partyId The party ID to accept the join request for. presence The presence to accept as a party member. Returns A task to represent the asynchronous operation.
async Task< IMatchmakerTicket >	AddMatchmakerAsync (string query="*", int minCount=2, int maxCount=8, Dictionary< string, string > stringProperties=null, Dictionary< string, double > numericProperties=null, int? countMultiple=null)
	Join the matchmaker pool and search for opponents on the server. Parameters query The matchmaker query to search for opponents. minCount The minimum number of players to compete against in a match. maxCount The maximum number of players to compete against in a match. stringProperties A set of key/value properties to provide to searches. numericProperties A set of key/value numeric properties to provide to searches. countMultiple An optional integer to force the matchmaker to match in multiples of. Returns A task which resolves to a matchmaker ticket object.
async Task< IPartyMatchmakerTicket >	AddMatchmakerPartyAsync (string partyId, string query, int minCount, int maxCount, Dictionary< string, string > stringProperties=null, Dictionary< string, double > numericProperties=null, int? countMultiple=null)
	Begin matchmaking as a party. Parameters partyId Party ID. query Filter query used to identify suitable users. minCount Minimum total user count to match together. maxCount Maximum total user count to match together. stringProperties String properties. numericProperties Numeric properties. countMultiple An optional integer to force the matchmaker to match in multiples of. Returns A task which resolves to a party matchmaker ticket object.
Task	CloseAsync ()
	Close the socket connection to the server. Returns A task to represent the asynchronous operation.
Task	ConnectAsync (ISession session, bool appearOnline=false, int connectTimeoutSec=DefaultConnectTimeout, string langTag="en")
	Connect to the server. Parameters session The session of the user. appearOnline If the user who appear online to other users. connectTimeout The time allowed for the socket connection to be established. langTag The language tag of the user on the connected socket. Returns A task to represent the asynchronous operation.
Task	ClosePartyAsync (string partyId)
	End a party, kicking all party members and closing it. Parameters partyId The ID of the party. Returns A task to represent the asynchronous operation.
async Task< IMatch >	CreateMatchAsync (string name=null)
	Create a multiplayer match on the server. Returns A task to represent the asynchronous operation.
async Task< IParty >	CreatePartyAsync (bool open, bool hidden, int maxSize, string label=null)
	Create a party. Parameters open Whether the party will require join requests to be approved by the party leader. hidden Whether the party should be hidden from client listing. maxSize Maximum number of party members. label An optional label to set for party listing. Returns A task to represent the asynchronous operation.
Task< IStatus >	FollowUsersAsync (IEnumerable< IApiUser > users)
	Subscribe to one or more users for their status updates. Parameters users The users. Returns A task which resolves to the current statuses for the users.
async Task< IStatus >	FollowUsersAsync (IEnumerable< string > userIDs, IEnumerable< string > usernames=null)
	Subscribe to one or more users for their status updates. Parameters userIDs The IDs of users. usernames The usernames of the users. Returns A task which resolves to the current statuses for the users.
async Task< IChannel >	JoinChatAsync (string target, ChannelType type, bool persistence=false, bool hidden=false)
	Join a chat channel on the server. Parameters target The target channel to join. type The type of channel to join. persistence If chat messages should be stored. hidden If the current user should be hidden on the channel. Returns A task which resolves to a chat channel object.
async Task< IMatch >	JoinMatchAsync (IMatchmakerMatched matched)
	Join a multiplayer match with the matchmaker matched object. Parameters matched A matchmaker matched object. Returns A task which resolves to a multiplayer match.
async Task< IMatch >	JoinMatchAsync (string matchId, IDictionary< string, string > metadata=null)
	Join a multiplayer match by ID. Parameters matchId The ID of the match to attempt to join. metadata An optional set of key-value metadata pairs to be passed to the match handler. Returns A task which resolves to a multiplayer match.
Task	JoinPartyAsync (string partyId)
	Join a party. Parameters partyId Party ID Returns A task to represent the asynchronous operation.
Task	LeaveChatAsync (IChannel channel)
	Leave a chat channel on the server. Parameters channel The chat channel to leave. Returns A task which represents the asynchronous operation.
Task	LeaveChatAsync (string channelId)
	Leave a chat channel on the server. Parameters channelId The ID of the chat channel to leave. Returns A task which represents the asynchronous operation.
Task	LeaveMatchAsync (IMatch match)
	Leave a multiplayer match on the server. Parameters match The multiplayer match to leave. Returns A task which represents the asynchronous operation.
Task	LeaveMatchAsync (string matchId)
	Leave a multiplayer match on the server. Parameters matchId The multiplayer match to leave. Returns A task which represents the asynchronous operation.
Task	LeavePartyAsync (string partyId)
	Leave the party. Parameters partyId Party ID. Returns A task to represent the asynchronous operation.
async Task< IPartyJoinRequest >	ListPartyJoinRequestsAsync (string partyId)
	Request a list of pending join requests for a party. Parameters partyId Party ID. Returns A task which resolves to a list of all party join requests.
Task	PromotePartyMemberAsync (string partyId, IUserPresence partyMember)
	Promote a new party leader. Parameters partyId Party ID. partyMember The presence of an existing party member to promote as the new leader. Returns A task which resolves to an announcement of a new party leader.
Task< IChannelMessageAck >	RemoveChatMessageAsync (IChannel channel, string messageId)
	Remove a chat message from a chat channel on the server. Parameters channel The chat channel with the message to remove. messageId The ID of the chat message to remove. Returns A task which resolves to an acknowledgement of the removed message.
async Task< IChannelMessageAck >	RemoveChatMessageAsync (string channelId, string messageId)
	Remove a chat message from a chat channel on the server. Parameters channelId The ID of the chat channel with the message to remove. messageId The ID of the chat message to remove. Returns A task which resolves to an acknowledgement of the removed message.
Task	RemoveMatchmakerAsync (IMatchmakerTicket ticket)
	Leave the matchmaker pool with the ticket. Parameters ticket The ticket returned by the matchmaker on join. Returns A task which represents the asynchronous operation.
Task	RemoveMatchmakerAsync (string ticket)
	Leave the matchmaker pool with the ticket contents. Parameters ticket The contents of the ticket returned by the matchmaker on join. Returns A task which represents the asynchronous operation.
Task	RemoveMatchmakerPartyAsync (string partyId, string ticket)
	Cancel a party matchmaking process using a ticket. Parameters partyId Party ID. ticket The ticket to cancel. Returns A task which represents the asynchronous operation.
Task	RemovePartyMemberAsync (string partyId, IUserPresence presence)
	Kick a party member, or decline a request to join. Parameters partyId Party ID to remove/reject from. presence The presence to remove or reject. Returns A task which represents the asynchronous operation.
async Task< IApiRpc >	RpcAsync (string funcId, string payload=null)
	Execute an RPC function to the server. Parameters funcId The ID of the function to execute. payload An (optional) payload to send to the server. Returns A task which resolves to the RPC function response object.
async Task< IApiRpc >	RpcAsync (string funcId, ArraySegment< byte > payload)
	Execute an RPC function to the server. Parameters funcId The ID of the function to execute. payload An (optional) payload sent to the server from the byte buffer. Returns A task which resolves to the RPC function response object.
Task	SendMatchStateAsync (string matchId, long opCode, ArraySegment< byte > state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server. Parameters matchId The ID of the match. opCode An operation code for the input. state The input data to send from the byte buffer. presences The presences in the match who should receive the input. Returns A task which represents the asynchronous operation.
Task	SendMatchStateAsync (string matchId, long opCode, string state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server./// When no presences are supplied the new match state will be sent to all presences.
Task	SendMatchStateAsync (string matchId, long opCode, byte[] state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server./// When no presences are supplied the new match state will be sent to all presences.
Task	SendPartyDataAsync (string partyId, long opCode, ArraySegment< byte > data)
	Send data to a party. Parameters partyId Party ID to send to. opCode Op code value. data The input data to send from the byte buffer, if any. Returns A task which represents the asynchronous operation.
Task	SendPartyDataAsync (string partyId, long opCode, string data)
	Send data to a party. Parameters partyId Party ID to send to. opCode Op code value. data Data payload, if any. Returns A task which represents the asynchronous operation.
Task	SendPartyDataAsync (string partyId, long opCode, byte[] data)
	Send data to a party. Parameters partyId Party ID to send to. opCode Op code value. data Data payload, if any. Returns A task which represents the asynchronous operation.
override string	ToString ()
Task	UnfollowUsersAsync (IEnumerable< IApiUser > users)
	Unfollow one or more users from their status updates. Parameters users The users to unfollow. Returns A task which represents the asynchronous operation.
Task	UnfollowUsersAsync (IEnumerable< string > userIDs)
	Unfollow one or more users from their status updates. Parameters userIDs The IDs of the users to unfollow. Returns A task which represents the asynchronous operation.
Task< IChannelMessageAck >	UpdateChatMessageAsync (IChannel channel, string messageId, string content)
	Update a chat message on a chat channel in the server. Parameters channel The chat channel with the message to update. messageId The ID of the message to update. content The new contents of the chat message. Returns A task which resolves to an acknowledgement of the updated message.
async Task< IChannelMessageAck >	UpdateChatMessageAsync (string channelId, string messageId, string content)
	Update a chat message on a chat channel in the server. Parameters channelId The ID of the chat channel with the message to update. messageId The ID of the message to update. content The new contents of the chat message. Returns A task which resolves to an acknowledgement of the updated message.
async Task< IPartyUpdate >	UpdatePartyAsync (string partyId, bool open, bool hidden, string label)
	Update party label and optionally whether it is open or closed.
Task	UpdateStatusAsync (string status)
	Update the status for the current user online. Parameters status The new status for the user. Returns A task which represents the asynchronous operation.
Task< IChannelMessageAck >	WriteChatMessageAsync (IChannel channel, string content)
	Send a chat message to a chat channel on the server. Parameters channel The chat channel to send onto. content The contents of the message to send. Returns A task which resolves to the acknowledgement of the chat message write.
async Task< IChannelMessageAck >	WriteChatMessageAsync (string channelId, string content)
	Send a chat message to a chat channel on the server. Parameters channelId The ID of the chat channel to send onto. content The contents of the message to send. Returns A task which resolves to the acknowledgement of the chat message write.

Static Public Member Functions
static ISocket	From (IClient client)
	Build a socket from a client object.
static ISocket	From (IClient client, ISocketAdapter adapter)
	Build a socket from a client object and socket adapter.

Static Public Attributes
const int	DefaultConnectTimeout = 30
	The default timeout for when the socket connects.
const int	DefaultSendTimeout = 10
	The default timeout for when the socket sends a message.

Properties
bool	IsConnected [get]
	If the socket is connected.
bool	IsConnecting [get]
	If the socket is connecting.
ILogger	Logger [get, set]
	The logger to use with the socket.

Events
Action	Closed
Action	Connected
Action< IApiChannelMessage >	ReceivedChannelMessage
Action< IChannelPresenceEvent >	ReceivedChannelPresence
Action< Exception >	ReceivedError
Action< IMatchmakerMatched >	ReceivedMatchmakerMatched
Action< IMatchState >	ReceivedMatchState
Action< IMatchPresenceEvent >	ReceivedMatchPresence
Action< IApiNotification >	ReceivedNotification
Action< IStatusPresenceEvent >	ReceivedStatusPresence
Action< IStreamPresenceEvent >	ReceivedStreamPresence
Action< IStreamState >	ReceivedStreamState
Action< IParty >	ReceivedParty
Action< IPartyClose >	ReceivedPartyClose
Action< IPartyData >	ReceivedPartyData
Action< IPartyUpdate >	ReceivedPartyUpdate
Action< IPartyJoinRequest >	ReceivedPartyJoinRequest
Action< IPartyLeader >	ReceivedPartyLeader
Action< IPartyPresenceEvent >	ReceivedPartyPresence
Action< IPartyMatchmakerTicket >	ReceivedPartyMatchmakerTicket
Events inherited from Nakama.ISocket
Action	Closed
	Received when a socket is closed.
Action	Connected
	Received when a socket is connected.
Action< IApiChannelMessage >	ReceivedChannelMessage
	Received a chat channel message.
Action< IChannelPresenceEvent >	ReceivedChannelPresence
	Received a presence change for joins and leaves with users in a chat channel.
Action< Exception >	ReceivedError
	Received when an error occurs on the socket.
Action< IMatchmakerMatched >	ReceivedMatchmakerMatched
	Received a matchmaker matched message.
Action< IMatchState >	ReceivedMatchState
	Received a message from a multiplayer match.
Action< IMatchPresenceEvent >	ReceivedMatchPresence
	Received a presence change for joins and leaves of users in a multiplayer match.
Action< IApiNotification >	ReceivedNotification
	Received a notification for the current user.
Action< IParty >	ReceivedParty
	Received a party event. This will occur when the current user's invitation request is accepted by the party leader of a closed party.
Action< IPartyClose >	ReceivedPartyClose
	Received a party close event.
Action< IPartyData >	ReceivedPartyData
	Received custom party data.
Action< IPartyJoinRequest >	ReceivedPartyJoinRequest
	Received a request to join the party.
Action< IPartyLeader >	ReceivedPartyLeader
	Received a change in the party leader.
Action< IPartyMatchmakerTicket >	ReceivedPartyMatchmakerTicket
	Received a new matchmaker ticket for the party.
Action< IPartyPresenceEvent >	ReceivedPartyPresence
	Received a new presence event in the party.
Action< IPartyUpdate >	ReceivedPartyUpdate
	Received a party label and/or open/closed change.
Action< IStatusPresenceEvent >	ReceivedStatusPresence
	Received a presence change for when a user updated their online status.
Action< IStreamPresenceEvent >	ReceivedStreamPresence
	Received a presence change for joins and leaves on a realtime stream.
Action< IStreamState >	ReceivedStreamState
	Received a message from a realtime stream.

Detailed Description

A socket which implements the Nakama realtime API.

Constructor & Destructor Documentation

Socket() [1/3]

Nakama.Socket.Socket ( )

inline

A new socket with default options.

Socket() [2/3]

Nakama.Socket.Socket ( ISocketAdapter adapter )

inline

A new socket with an adapter.

Parameters

adapter

The adapter for use with the socket.

Socket() [3/3]

Nakama.Socket.Socket ( string scheme, string host, int port, ISocketAdapter adapter, int sendTimeoutSec = DefaultSendTimeout )

inline

A new socket with server connection and adapter options.

Parameters

scheme	The protocol scheme. Must be "ws" or "wss".
host	The host address of the server.
port	The port number of the server.
adapter	The adapter for use with the socket.
sendTimeoutSec	The maximum time allowed for a message to be sent.

Member Function Documentation

AcceptPartyMemberAsync()

Task Nakama.Socket.AcceptPartyMemberAsync ( string partyId, IUserPresence presence )

inline

Accept a party member's request to join the party.

Parameters

partyId	The party ID to accept the join request for.
presence	The presence to accept as a party member.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

AddMatchmakerAsync()

async Task< IMatchmakerTicket > Nakama.Socket.AddMatchmakerAsync ( string query = "*", int minCount = 2, int maxCount = 8, Dictionary< string, string > stringProperties = null, Dictionary< string, double > numericProperties = null, int? countMultiple = null )

inline

Join the matchmaker pool and search for opponents on the server.

Parameters

query	The matchmaker query to search for opponents.
minCount	The minimum number of players to compete against in a match.
maxCount	The maximum number of players to compete against in a match.
stringProperties	A set of key/value properties to provide to searches.
numericProperties	A set of key/value numeric properties to provide to searches.
countMultiple	An optional integer to force the matchmaker to match in multiples of.

Returns

A task which resolves to a matchmaker ticket object.

Implements Nakama.ISocket.

AddMatchmakerPartyAsync()

async Task< IPartyMatchmakerTicket > Nakama.Socket.AddMatchmakerPartyAsync ( string partyId, string query, int minCount, int maxCount, Dictionary< string, string > stringProperties = null, Dictionary< string, double > numericProperties = null, int? countMultiple = null )

inline

Begin matchmaking as a party.

Parameters

partyId	Party ID.
query	Filter query used to identify suitable users.
minCount	Minimum total user count to match together.
maxCount	Maximum total user count to match together.
stringProperties	String properties.
numericProperties	Numeric properties.
countMultiple	An optional integer to force the matchmaker to match in multiples of.

Returns

A task which resolves to a party matchmaker ticket object.

Implements Nakama.ISocket.

CloseAsync()

Task Nakama.Socket.CloseAsync

(

)

Close the socket connection to the server.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

ClosePartyAsync()

Task Nakama.Socket.ClosePartyAsync ( string partyId )

inline

End a party, kicking all party members and closing it.

Parameters

partyId

The ID of the party.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

ConnectAsync()

Task Nakama.Socket.ConnectAsync ( ISession session, bool appearOnline = false, int connectTimeoutSec = DefaultConnectTimeout, string langTag = "en" )

inline

Connect to the server.

Parameters

session	The session of the user.
appearOnline	If the user who appear online to other users.
connectTimeout	The time allowed for the socket connection to be established.
langTag	The language tag of the user on the connected socket.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

CreateMatchAsync()

async Task< IMatch > Nakama.Socket.CreateMatchAsync ( string name = null )

inline

Create a multiplayer match on the server.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

CreatePartyAsync()

async Task< IParty > Nakama.Socket.CreatePartyAsync ( bool open, bool hidden, int maxSize, string label = null )

inline

Create a party.

Parameters

open	Whether the party will require join requests to be approved by the party leader.
hidden	Whether the party should be hidden from client listing.
maxSize	Maximum number of party members.
label	An optional label to set for party listing.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

FollowUsersAsync() [1/2]

Task< IStatus > Nakama.Socket.FollowUsersAsync

(

IEnumerable< IApiUser >

users

)

Subscribe to one or more users for their status updates.

Parameters

users

The users.

Returns

A task which resolves to the current statuses for the users.

Implements Nakama.ISocket.

FollowUsersAsync() [2/2]

async Task< IStatus > Nakama.Socket.FollowUsersAsync ( IEnumerable< string > userIDs, IEnumerable< string > usernames = null )

inline

Subscribe to one or more users for their status updates.

Parameters

userIDs	The IDs of users.
usernames	The usernames of the users.

Returns

A task which resolves to the current statuses for the users.

Implements Nakama.ISocket.

From() [1/2]

ISocket Nakama.Socket.From ( IClient client )

static

Build a socket from a client object.

Parameters

client

A client object.

Returns

A new socket with the connection settings from the client.

From() [2/2]

ISocket Nakama.Socket.From ( IClient client, ISocketAdapter adapter )

inlinestatic

Build a socket from a client object and socket adapter.

Parameters

client	A client object.
adapter	The socket adapter to use with the connection.

Returns

A new socket with connection settings from the client.

JoinChatAsync()

async Task< IChannel > Nakama.Socket.JoinChatAsync ( string target, ChannelType type, bool persistence = false, bool hidden = false )

inline

Join a chat channel on the server.

Parameters

target	The target channel to join.
type	The type of channel to join.
persistence	If chat messages should be stored.
hidden	If the current user should be hidden on the channel.

Returns

A task which resolves to a chat channel object.

Implements Nakama.ISocket.

JoinMatchAsync() [1/2]

async Task< IMatch > Nakama.Socket.JoinMatchAsync ( IMatchmakerMatched matched )

inline

Join a multiplayer match with the matchmaker matched object.

Parameters

matched

A matchmaker matched object.

Returns

A task which resolves to a multiplayer match.

Implements Nakama.ISocket.

JoinMatchAsync() [2/2]

async Task< IMatch > Nakama.Socket.JoinMatchAsync ( string matchId, IDictionary< string, string > metadata = null )

inline

Join a multiplayer match by ID.

Parameters

matchId	The ID of the match to attempt to join.
metadata	An optional set of key-value metadata pairs to be passed to the match handler.

Returns

A task which resolves to a multiplayer match.

Implements Nakama.ISocket.

JoinPartyAsync()

Task Nakama.Socket.JoinPartyAsync ( string partyId )

inline

Join a party.

Parameters

partyId

Party ID

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

LeaveChatAsync() [1/2]

Task Nakama.Socket.LeaveChatAsync

(

IChannel

channel

)

Leave a chat channel on the server.

Parameters

channel

The chat channel to leave.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

LeaveChatAsync() [2/2]

Task Nakama.Socket.LeaveChatAsync ( string channelId )

inline

Leave a chat channel on the server.

Parameters

channelId

The ID of the chat channel to leave.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

LeaveMatchAsync() [1/2]

Task Nakama.Socket.LeaveMatchAsync

(

IMatch

match

)

Leave a multiplayer match on the server.

Parameters

match

The multiplayer match to leave.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

LeaveMatchAsync() [2/2]

Task Nakama.Socket.LeaveMatchAsync ( string matchId )

inline

Leave a multiplayer match on the server.

Parameters

matchId

The multiplayer match to leave.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

LeavePartyAsync()

Task Nakama.Socket.LeavePartyAsync ( string partyId )

inline

Leave the party.

Parameters

partyId

Party ID.

Returns

A task to represent the asynchronous operation.

Implements Nakama.ISocket.

ListPartyJoinRequestsAsync()

async Task< IPartyJoinRequest > Nakama.Socket.ListPartyJoinRequestsAsync ( string partyId )

inline

Request a list of pending join requests for a party.

Parameters

partyId

Party ID.

Returns

A task which resolves to a list of all party join requests.

Implements Nakama.ISocket.

PromotePartyMemberAsync()

Task Nakama.Socket.PromotePartyMemberAsync ( string partyId, IUserPresence partyMember )

inline

Promote a new party leader.

Parameters

partyId	Party ID.
partyMember	The presence of an existing party member to promote as the new leader.

Returns

A task which resolves to an announcement of a new party leader.

Implements Nakama.ISocket.

RemoveChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.Socket.RemoveChatMessageAsync	(	IChannel	channel,
		string	messageId )

Remove a chat message from a chat channel on the server.

Parameters

channel	The chat channel with the message to remove.
messageId	The ID of the chat message to remove.

Returns

A task which resolves to an acknowledgement of the removed message.

Implements Nakama.ISocket.

RemoveChatMessageAsync() [2/2]

async Task< IChannelMessageAck > Nakama.Socket.RemoveChatMessageAsync ( string channelId, string messageId )

inline

Remove a chat message from a chat channel on the server.

Parameters

channelId	The ID of the chat channel with the message to remove.
messageId	The ID of the chat message to remove.

Returns

A task which resolves to an acknowledgement of the removed message.

Implements Nakama.ISocket.

RemoveMatchmakerAsync() [1/2]

Task Nakama.Socket.RemoveMatchmakerAsync

(

IMatchmakerTicket

ticket

)

Leave the matchmaker pool with the ticket.

Parameters

ticket

The ticket returned by the matchmaker on join.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

RemoveMatchmakerAsync() [2/2]

Task Nakama.Socket.RemoveMatchmakerAsync ( string ticket )

inline

Leave the matchmaker pool with the ticket contents.

Parameters

ticket

The contents of the ticket returned by the matchmaker on join.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

RemoveMatchmakerPartyAsync()

Task Nakama.Socket.RemoveMatchmakerPartyAsync ( string partyId, string ticket )

inline

Cancel a party matchmaking process using a ticket.

Parameters

partyId	Party ID.
ticket	The ticket to cancel.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

RemovePartyMemberAsync()

Task Nakama.Socket.RemovePartyMemberAsync ( string partyId, IUserPresence presence )

inline

Kick a party member, or decline a request to join.

Parameters

partyId	Party ID to remove/reject from.
presence	The presence to remove or reject.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

RpcAsync() [1/2]

async Task< IApiRpc > Nakama.Socket.RpcAsync ( string funcId, ArraySegment< byte > payload )

inline

Execute an RPC function to the server.

Parameters

funcId	The ID of the function to execute.
payload	An (optional) payload sent to the server from the byte buffer.

Returns

A task which resolves to the RPC function response object.

Implements Nakama.ISocket.

RpcAsync() [2/2]

async Task< IApiRpc > Nakama.Socket.RpcAsync ( string funcId, string payload = null )

inline

Execute an RPC function to the server.

Parameters

funcId	The ID of the function to execute.
payload	An (optional) payload to send to the server.

Returns

A task which resolves to the RPC function response object.

Implements Nakama.ISocket.

SendMatchStateAsync() [1/3]

Task Nakama.Socket.SendMatchStateAsync ( string matchId, long opCode, ArraySegment< byte > state, IEnumerable< IUserPresence > presences = null )

inline

Send input to a multiplayer match on the server.

Parameters

matchId	The ID of the match.
opCode	An operation code for the input.
state	The input data to send from the byte buffer.
presences	The presences in the match who should receive the input.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

SendMatchStateAsync() [2/3]

Task Nakama.Socket.SendMatchStateAsync ( string matchId, long opCode, byte[] state, IEnumerable< IUserPresence > presences = null )

inline

Send input to a multiplayer match on the server./// When no presences are supplied the new match state will be sent to all presences.

Implements Nakama.ISocket.

SendMatchStateAsync() [3/3]

Task Nakama.Socket.SendMatchStateAsync	(	string	matchId,
		long	opCode,
		string	state,
		IEnumerable< IUserPresence >	presences = null )

Send input to a multiplayer match on the server./// When no presences are supplied the new match state will be sent to all presences.

Implements Nakama.ISocket.

SendPartyDataAsync() [1/3]

Task Nakama.Socket.SendPartyDataAsync ( string partyId, long opCode, ArraySegment< byte > data )

inline

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	The input data to send from the byte buffer, if any.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

SendPartyDataAsync() [2/3]

Task Nakama.Socket.SendPartyDataAsync ( string partyId, long opCode, byte[] data )

inline

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	Data payload, if any.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

SendPartyDataAsync() [3/3]

Task Nakama.Socket.SendPartyDataAsync	(	string	partyId,
		long	opCode,
		string	data )

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	Data payload, if any.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

ToString()

override string Nakama.Socket.ToString ( )

inline

UnfollowUsersAsync() [1/2]

Task Nakama.Socket.UnfollowUsersAsync

(

IEnumerable< IApiUser >

users

)

Unfollow one or more users from their status updates.

Parameters

users

The users to unfollow.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

UnfollowUsersAsync() [2/2]

Task Nakama.Socket.UnfollowUsersAsync ( IEnumerable< string > userIDs )

inline

Unfollow one or more users from their status updates.

Parameters

userIDs

The IDs of the users to unfollow.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

UpdateChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.Socket.UpdateChatMessageAsync	(	IChannel	channel,
		string	messageId,
		string	content )

Update a chat message on a chat channel in the server.

Parameters

channel	The chat channel with the message to update.
messageId	The ID of the message to update.
content	The new contents of the chat message.

Returns

A task which resolves to an acknowledgement of the updated message.

Implements Nakama.ISocket.

UpdateChatMessageAsync() [2/2]

async Task< IChannelMessageAck > Nakama.Socket.UpdateChatMessageAsync ( string channelId, string messageId, string content )

inline

Update a chat message on a chat channel in the server.

Parameters

channelId	The ID of the chat channel with the message to update.
messageId	The ID of the message to update.
content	The new contents of the chat message.

Returns

A task which resolves to an acknowledgement of the updated message.

Implements Nakama.ISocket.

UpdatePartyAsync()

async Task< IPartyUpdate > Nakama.Socket.UpdatePartyAsync ( string partyId, bool open, bool hidden, string label )

inline

Update party label and optionally whether it is open or closed.

Parameters

partyId	The Party ID.
open	Whether the party is open or closed.
hidden	Whether the party should be hidden from client listing.
label	The new custom label to set to the party.

Returns

Implements Nakama.ISocket.

UpdateStatusAsync()

Task Nakama.Socket.UpdateStatusAsync ( string status )

inline

Update the status for the current user online.

Parameters

status

The new status for the user.

Returns

A task which represents the asynchronous operation.

Implements Nakama.ISocket.

WriteChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.Socket.WriteChatMessageAsync	(	IChannel	channel,
		string	content )

Send a chat message to a chat channel on the server.

Parameters

channel	The chat channel to send onto.
content	The contents of the message to send.

Returns

A task which resolves to the acknowledgement of the chat message write.

Implements Nakama.ISocket.

WriteChatMessageAsync() [2/2]

async Task< IChannelMessageAck > Nakama.Socket.WriteChatMessageAsync ( string channelId, string content )

inline

Send a chat message to a chat channel on the server.

Parameters

channelId	The ID of the chat channel to send onto.
content	The contents of the message to send.

Returns

A task which resolves to the acknowledgement of the chat message write.

Implements Nakama.ISocket.

Member Data Documentation

DefaultConnectTimeout

const int Nakama.Socket.DefaultConnectTimeout = 30

static

The default timeout for when the socket connects.

DefaultSendTimeout

const int Nakama.Socket.DefaultSendTimeout = 10

static

The default timeout for when the socket sends a message.

Property Documentation

IsConnected

bool Nakama.Socket.IsConnected

get

If the socket is connected.

Implements Nakama.ISocket.

IsConnecting

bool Nakama.Socket.IsConnecting

get

If the socket is connecting.

Implements Nakama.ISocket.

Logger

ILogger Nakama.Socket.Logger

getset

The logger to use with the socket.

Event Documentation

Closed

Action Nakama.Socket.Closed

Connected

Action Nakama.Socket.Connected

ReceivedChannelMessage

Action<IApiChannelMessage> Nakama.Socket.ReceivedChannelMessage

ReceivedChannelPresence

Action<IChannelPresenceEvent> Nakama.Socket.ReceivedChannelPresence

ReceivedError

Action<Exception> Nakama.Socket.ReceivedError

ReceivedMatchmakerMatched

Action<IMatchmakerMatched> Nakama.Socket.ReceivedMatchmakerMatched

ReceivedMatchPresence

Action<IMatchPresenceEvent> Nakama.Socket.ReceivedMatchPresence

ReceivedMatchState

Action<IMatchState> Nakama.Socket.ReceivedMatchState

ReceivedNotification

Action<IApiNotification> Nakama.Socket.ReceivedNotification

ReceivedParty

Action<IParty> Nakama.Socket.ReceivedParty

ReceivedPartyClose

Action<IPartyClose> Nakama.Socket.ReceivedPartyClose

ReceivedPartyData

Action<IPartyData> Nakama.Socket.ReceivedPartyData

ReceivedPartyJoinRequest

Action<IPartyJoinRequest> Nakama.Socket.ReceivedPartyJoinRequest

ReceivedPartyLeader

Action<IPartyLeader> Nakama.Socket.ReceivedPartyLeader

ReceivedPartyMatchmakerTicket

Action<IPartyMatchmakerTicket> Nakama.Socket.ReceivedPartyMatchmakerTicket

ReceivedPartyPresence

Action<IPartyPresenceEvent> Nakama.Socket.ReceivedPartyPresence

ReceivedPartyUpdate

Action<IPartyUpdate> Nakama.Socket.ReceivedPartyUpdate

ReceivedStatusPresence

Action<IStatusPresenceEvent> Nakama.Socket.ReceivedStatusPresence

ReceivedStreamPresence

Action<IStreamPresenceEvent> Nakama.Socket.ReceivedStreamPresence

ReceivedStreamState

Action<IStreamState> Nakama.Socket.ReceivedStreamState

---

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

• Socket.cs