#include <NRtClientInterface.h>

Public Member Functions
virtual	~NRtClientInterface ()

virtual void	tick ()=0

virtual void	setListener (NRtClientListenerInterface *listener)=0

virtual void	setUserData (void *userData)=0

virtual void *	getUserData () const =0

virtual void	connect (NSessionPtr session, bool createStatus, NRtClientProtocol protocol=NRtClientProtocol::Protobuf)=0

virtual bool	isConnected () const =0

virtual void	disconnect ()=0

virtual NRtTransportPtr	getTransport () const =0

virtual void	joinChat (const std::string &target, NChannelType type, const opt::optional< bool > &persistence=opt::nullopt, const opt::optional< bool > &hidden=opt::nullopt, std::function< void(NChannelPtr)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	leaveChat (const std::string &channelId, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	writeChatMessage (const std::string &channelId, const std::string &content, std::function< void(const NChannelMessageAck &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	updateChatMessage (const std::string &channelId, const std::string &messageId, const std::string &content, std::function< void(const NChannelMessageAck &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	removeChatMessage (const std::string &channelId, const std::string &messageId, std::function< void(const NChannelMessageAck &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	createMatch (std::function< void(const NMatch &)> successCallback, RtErrorCallback errorCallback=nullptr)=0

virtual void	joinMatch (const std::string &matchId, const NStringMap &metadata, std::function< void(const NMatch &)> successCallback, RtErrorCallback errorCallback=nullptr)=0

virtual void	joinMatchByToken (const std::string &token, std::function< void(const NMatch &)> successCallback, RtErrorCallback errorCallback=nullptr)=0

virtual void	leaveMatch (const std::string &matchId, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	addMatchmaker (const opt::optional< int32_t > &minCount=opt::nullopt, const opt::optional< int32_t > &maxCount=opt::nullopt, const opt::optional< std::string > &query=opt::nullopt, const NStringMap &stringProperties={}, const NStringDoubleMap &numericProperties={}, std::function< void(const NMatchmakerTicket &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	removeMatchmaker (const std::string &ticket, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	sendMatchData (const std::string &matchId, int64_t opCode, const NBytes &data, const std::vector< NUserPresence > &presences={})=0

virtual void	followUsers (const std::vector< std::string > &userIds, std::function< void(const NStatus &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	unfollowUsers (const std::vector< std::string > &userIds, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	updateStatus (const std::string &status, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	rpc (const std::string &id, const opt::optional< std::string > &payload=opt::nullopt, std::function< void(const NRpc &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	acceptPartyMember (const std::string &partyId, NUserPresence &presence, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	addMatchmakerParty (const std::string &partyId, const std::string &query, int32_t minCount, int32_t maxCount, const NStringMap stringProperties={}, const NStringDoubleMap numericProperties={}, std::function< void(const NPartyMatchmakerTicket &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	closeParty (const std::string &partyId, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	createParty (bool open, int maxSize, std::function< void(const NParty &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	joinParty (const std::string &partyId, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	leaveParty (const std::string &partyId, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	listPartyJoinRequests (const std::string &partyId, std::function< void(const NPartyJoinRequest &)> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	promotePartyMember (const std::string &partyId, NUserPresence &partyMember, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	removeMatchmakerParty (const std::string &partyId, const std::string &ticket, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	removePartyMember (const std::string &partyId, NUserPresence &presence, std::function< void()> successCallback=nullptr, RtErrorCallback errorCallback=nullptr)=0

virtual void	sendPartyData (const std::string &partyId, long opCode, NBytes &data)=0

Detailed Description

A real-time client interface to interact with Nakama server.

Constructor & Destructor Documentation

◆ ~NRtClientInterface()

virtual NRtClientInterface::~NRtClientInterface ( )

inlinevirtual

Member Function Documentation

◆ acceptPartyMember()

virtual void NRtClientInterface::acceptPartyMember	(	const std::string &	partyId,
		NUserPresence &	presence,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

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.

◆ addMatchmaker()

virtual void NRtClientInterface::addMatchmaker	(	const opt::optional< int32_t > &	minCount = `opt::nullopt`,
		const opt::optional< int32_t > &	maxCount = `opt::nullopt`,
		const opt::optional< std::string > &	query = `opt::nullopt`,
		const NStringMap &	stringProperties = `{}`,
		const NStringDoubleMap &	numericProperties = `{}`,
		std::function< void(const NMatchmakerTicket &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

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

Parameters

minCount	The minimum number of players to compete against.
maxCount	The maximum number of players to compete against.
query	A matchmaker query to search for opponents.
stringProperties	A set of k/v properties to provide in searches.
numericProperties	A set of k/v numeric properties to provide in searches.

◆ addMatchmakerParty()

virtual void NRtClientInterface::addMatchmakerParty	(	const std::string &	partyId,
		const std::string &	query,
		int32_t	minCount,
		int32_t	maxCount,
		const NStringMap	stringProperties = `{}`,
		const NStringDoubleMap	numericProperties = `{}`,
		std::function< void(const NPartyMatchmakerTicket &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

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.

◆ closeParty()

virtual void NRtClientInterface::closeParty	(	const std::string &	partyId,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

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

Parameters

partyId The ID of the party.

◆ connect()

virtual void NRtClientInterface::connect	(	NSessionPtr	session,
		bool	createStatus,
		NRtClientProtocol	protocol = `NRtClientProtocol::Protobuf`
	)

pure virtual

Connect to the server.

Parameters

session	The session of the user.
createStatus	True if the socket should show the user as online to others.
protocol	Communication protocol. Default is Protobuf.

◆ createMatch()

virtual void NRtClientInterface::createMatch	(	std::function< void(const NMatch &)>	successCallback,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Create a multiplayer match on the server.

◆ createParty()

virtual void NRtClientInterface::createParty	(	bool	open,
		int	maxSize,
		std::function< void(const NParty &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Create a party.

Parameters

open	Whether or not the party will require join requests to be approved by the party leader.
maxSize	Maximum number of party members.

◆ disconnect()

virtual void NRtClientInterface::disconnect ( )

pure virtual

Close the connection with the server.

◆ followUsers()

virtual void NRtClientInterface::followUsers	(	const std::vector< std::string > &	userIds,
		std::function< void(const NStatus &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Follow one or more users for status updates.

Parameters

userIds The user Ids to follow.

◆ getTransport()

virtual NRtTransportPtr NRtClientInterface::getTransport ( ) const

pure virtual

Get websocket transport which RtClient uses.

◆ getUserData()

virtual void * NRtClientInterface::getUserData ( ) const

pure virtual

Get user data.

Returns: The user data.

◆ isConnected()

virtual bool NRtClientInterface::isConnected ( ) const

pure virtual

Returns: True if connected to server.

◆ joinChat()

virtual void NRtClientInterface::joinChat	(	const std::string &	target,
		NChannelType	type,
		const opt::optional< bool > &	persistence = `opt::nullopt`,
		const opt::optional< bool > &	hidden = `opt::nullopt`,
		std::function< void(NChannelPtr)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Join a chat channel on the server.

Parameters

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

◆ joinMatch()

virtual void NRtClientInterface::joinMatch	(	const std::string &	matchId,
		const NStringMap &	metadata,
		std::function< void(const NMatch &)>	successCallback,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Join a multiplayer match by ID.

Parameters

matchId A match ID.

◆ joinMatchByToken()

virtual void NRtClientInterface::joinMatchByToken	(	const std::string &	token,
		std::function< void(const NMatch &)>	successCallback,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Join a multiplayer match with a matchmaker.

Parameters

token A matchmaker ticket result object.

◆ joinParty()

virtual void NRtClientInterface::joinParty	(	const std::string &	partyId,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Join a party.

Parameters

partyId Party ID.

◆ leaveChat()

virtual void NRtClientInterface::leaveChat	(	const std::string &	channelId,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Leave a chat channel on the server.

Parameters

channelId The channel to leave.

◆ leaveMatch()

virtual void NRtClientInterface::leaveMatch	(	const std::string &	matchId,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Leave a match on the server.

Parameters

matchId The match to leave.

◆ leaveParty()

virtual void NRtClientInterface::leaveParty	(	const std::string &	partyId,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Leave the party.

Parameters

partyId Party ID.

◆ listPartyJoinRequests()

virtual void NRtClientInterface::listPartyJoinRequests	(	const std::string &	partyId,
		std::function< void(const NPartyJoinRequest &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Request a list of pending join requests for a party.

Parameters

partyId Party ID.

◆ promotePartyMember()

virtual void NRtClientInterface::promotePartyMember	(	const std::string &	partyId,
		NUserPresence &	partyMember,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Promote a new party leader.

Parameters

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

◆ removeChatMessage()

virtual void NRtClientInterface::removeChatMessage	(	const std::string &	channelId,
		const std::string &	messageId,
		std::function< void(const NChannelMessageAck &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Remove a chat message from a channel on the server.

Parameters

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

◆ removeMatchmaker()

virtual void NRtClientInterface::removeMatchmaker	(	const std::string &	ticket,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Leave the matchmaker pool by ticket.

Parameters

ticket The ticket returned by the matchmaker on join. See NMatchmakerTicket.ticket.

◆ removeMatchmakerParty()

virtual void NRtClientInterface::removeMatchmakerParty	(	const std::string &	partyId,
		const std::string &	ticket,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Cancel a party matchmaking process using a ticket.

Parameters

partyId	Party ID.
ticket	The ticket to cancel.

◆ removePartyMember()

virtual void NRtClientInterface::removePartyMember	(	const std::string &	partyId,
		NUserPresence &	presence,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

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.

◆ rpc()

virtual void NRtClientInterface::rpc	(	const std::string &	id,
		const opt::optional< std::string > &	payload = `opt::nullopt`,
		std::function< void(const NRpc &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Send an RPC message to the server.

Parameters

id	The ID of the function to execute.
payload	The string content to send to the server.

◆ sendMatchData()

virtual void NRtClientInterface::sendMatchData	(	const std::string &	matchId,
		int64_t	opCode,
		const NBytes &	data,
		const std::vector< NUserPresence > &	presences = `{}`
	)

pure virtual

Send a state change to a match on the server.

When no presences are supplied the new match state will be sent to all presences.

Parameters

matchId	The Id of the match.
opCode	An operation code for the match state.
data	The new state to send to the match.
presences	The presences in the match to send the state.

◆ sendPartyData()

virtual void NRtClientInterface::sendPartyData	(	const std::string &	partyId,
		long	opCode,
		NBytes &	data
	)

pure virtual

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.

◆ setListener()

virtual void NRtClientInterface::setListener ( NRtClientListenerInterface * listener )

pure virtual

Set events listener

Parameters

listener The listener of client events.

◆ setUserData()

virtual void NRtClientInterface::setUserData ( void * userData )

pure virtual

Set user data.

Client just holds this data so you can receive it later when you need it.

Parameters

userData The user data.

◆ tick()

virtual void NRtClientInterface::tick ( )

pure virtual

Pumps requests queue in your thread. Call it periodically, each 50 ms is ok.

◆ unfollowUsers()

virtual void NRtClientInterface::unfollowUsers	(	const std::vector< std::string > &	userIds,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Unfollow status updates for one or more users.

Parameters

userIds The ids of users to unfollow.

◆ updateChatMessage()

virtual void NRtClientInterface::updateChatMessage	(	const std::string &	channelId,
		const std::string &	messageId,
		const std::string &	content,
		std::function< void(const NChannelMessageAck &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Update a chat message to a channel on the server.

Parameters

channelId	The ID of the chat channel with the message.
messageId	The ID of the message to update.
content	The content update for the message. Must be a JSON object.

◆ updateStatus()

virtual void NRtClientInterface::updateStatus	(	const std::string &	status,
		std::function< void()>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Update the user's status online.

Parameters

status The new status of the user.

◆ writeChatMessage()

virtual void NRtClientInterface::writeChatMessage	(	const std::string &	channelId,
		const std::string &	content,
		std::function< void(const NChannelMessageAck &)>	successCallback = `nullptr`,
		RtErrorCallback	errorCallback = `nullptr`
	)

pure virtual

Send a chat message to a channel on the server.

Parameters

channelId	The channel to send on.
content	The content of the chat message. Must be a JSON object.

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

NRtClientInterface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~NRtClientInterface()

Member Function Documentation

◆ acceptPartyMember()

◆ addMatchmaker()

◆ addMatchmakerParty()

◆ closeParty()

◆ connect()

◆ createMatch()

◆ createParty()

◆ disconnect()

◆ followUsers()

◆ getTransport()

◆ getUserData()

◆ isConnected()

◆ joinChat()

◆ joinMatch()

◆ joinMatchByToken()

◆ joinParty()

◆ leaveChat()

◆ leaveMatch()

◆ leaveParty()

◆ listPartyJoinRequests()

◆ promotePartyMember()

◆ removeChatMessage()

◆ removeMatchmaker()

◆ removeMatchmakerParty()

◆ removePartyMember()

◆ rpc()

◆ sendMatchData()

◆ sendPartyData()

◆ setListener()

◆ setUserData()

◆ tick()

◆ unfollowUsers()

◆ updateChatMessage()

◆ updateStatus()

◆ writeChatMessage()