NRtDefaultClientListener Class Reference

#include <NRtDefaultClientListener.h>

Inheritance diagram for NRtDefaultClientListener:

Public Types
using	ConnectCallback = std::function< void()>
using	DisconnectCallback = std::function< void(const NRtClientDisconnectInfo &info)>
using	ErrorCallback = std::function< void(const NRtError &)>
using	ChannelMessageCallback = std::function< void(const NChannelMessage &)>
using	ChannelPresenceCallback = std::function< void(const NChannelPresenceEvent &)>
using	MatchmakerMatchedCallback = std::function< void(NMatchmakerMatchedPtr)>
using	MatchDataCallback = std::function< void(const NMatchData &)>
using	MatchPresenceCallback = std::function< void(const NMatchPresenceEvent &)>
using	NotificationsCallback = std::function< void(const NNotificationList &)>
using	PartyCallback = std::function< void(const NParty &)>
using	PartyClosedCallback = std::function< void(const NPartyClose &)>
using	PartyDataCallback = std::function< void(const NPartyData &)>
using	PartyJoinRequestCallback = std::function< void(const NPartyJoinRequest &)>
using	PartyLeaderCallback = std::function< void(const NPartyLeader &)>
using	PartyMatchmakerTicketCallback = std::function< void(const NPartyMatchmakerTicket &)>
using	PartyPresenceCallback = std::function< void(const NPartyPresenceEvent &)>
using	StatusPresenceCallback = std::function< void(const NStatusPresenceEvent &)>
using	StreamPresenceCallback = std::function< void(const NStreamPresenceEvent &)>
using	StreamDataCallback = std::function< void(const NStreamData &)>

Public Member Functions
void	setConnectCallback (ConnectCallback callback)
void	setDisconnectCallback (DisconnectCallback callback)
void	setErrorCallback (ErrorCallback callback)
void	setChannelMessageCallback (ChannelMessageCallback callback)
void	setChannelPresenceCallback (ChannelPresenceCallback callback)
void	setMatchmakerMatchedCallback (MatchmakerMatchedCallback callback)
void	setMatchDataCallback (MatchDataCallback callback)
void	setMatchPresenceCallback (MatchPresenceCallback callback)
void	setNotificationsCallback (NotificationsCallback callback)
void	setPartyCallback (PartyCallback callback)
void	setPartyCloseCallback (PartyClosedCallback callback)
void	setPartyDataCallback (PartyDataCallback callback)
void	setPartyJoinRequestCallback (PartyJoinRequestCallback callback)
void	setPartyLeaderCallback (PartyLeaderCallback callback)
void	setPartyMatchmakerTicketCallback (PartyMatchmakerTicketCallback callback)
void	setPartyPresenceCallback (PartyPresenceCallback callback)
void	setStatusPresenceCallback (StatusPresenceCallback callback)
void	setStreamPresenceCallback (StreamPresenceCallback callback)
void	setStreamDataCallback (StreamDataCallback callback)
Public Member Functions inherited from NRtClientListenerInterface
virtual	~NRtClientListenerInterface ()

Protected Member Functions
void	onConnect () override
void	onDisconnect (const NRtClientDisconnectInfo &info) override
void	onError (const NRtError &error) override
void	onChannelMessage (const NChannelMessage &message) override
void	onChannelPresence (const NChannelPresenceEvent &presence) override
void	onMatchmakerMatched (NMatchmakerMatchedPtr matched) override
void	onMatchData (const NMatchData &matchData) override
void	onMatchPresence (const NMatchPresenceEvent &matchPresence) override
void	onNotifications (const NNotificationList &notifications) override
void	onParty (const NParty &party) override
void	onPartyClosed (const NPartyClose &partyClosed) override
void	onPartyData (const NPartyData &partyData) override
void	onPartyJoinRequest (const NPartyJoinRequest &partyJoinRequest) override
void	onPartyLeader (const NPartyLeader &partyLeader) override
void	onPartyMatchmakerTicket (const NPartyMatchmakerTicket &partyMatchmakerTicket) override
void	onPartyPresence (const NPartyPresenceEvent &partyPresence) override
void	onStatusPresence (const NStatusPresenceEvent &presence) override
void	onStreamPresence (const NStreamPresenceEvent &presence) override
void	onStreamData (const NStreamData &data) override

Protected Attributes
ConnectCallback	_connectCallback
DisconnectCallback	_disconnectCallback
ErrorCallback	_errorCallback
ChannelMessageCallback	_channelMessageCallback
ChannelPresenceCallback	_channelPresenceCallback
MatchmakerMatchedCallback	_matchmakerMatchedCallback
MatchDataCallback	_matchDataCallback
MatchPresenceCallback	_matchPresenceCallback
NotificationsCallback	_notificationsCallback
PartyCallback	_partyCallback
PartyClosedCallback	_partyClosedCallback
PartyDataCallback	_partyDataCallback
PartyJoinRequestCallback	_partyJoinRequestCallback
PartyLeaderCallback	_partyLeaderCallback
PartyMatchmakerTicketCallback	_partyMatchmakerTicketCallback
PartyPresenceCallback	_partyPresenceCallback
StatusPresenceCallback	_statusPresenceCallback
StreamPresenceCallback	_streamPresenceCallback
StreamDataCallback	_streamDataCallback

Detailed Description

A default listener for receiving NRtClientInterface events. It allows to set callbacks for needed events without creating own class.

Member Typedef Documentation

ChannelMessageCallback

using NRtDefaultClientListener::ChannelMessageCallback = std::function<void(const NChannelMessage&)>

ChannelPresenceCallback

using NRtDefaultClientListener::ChannelPresenceCallback = std::function<void(const NChannelPresenceEvent&)>

ConnectCallback

using NRtDefaultClientListener::ConnectCallback = std::function<void()>

DisconnectCallback

using NRtDefaultClientListener::DisconnectCallback = std::function<void(const NRtClientDisconnectInfo& info)>

ErrorCallback

using NRtDefaultClientListener::ErrorCallback = std::function<void(const NRtError&)>

MatchDataCallback

using NRtDefaultClientListener::MatchDataCallback = std::function<void(const NMatchData&)>

MatchmakerMatchedCallback

using NRtDefaultClientListener::MatchmakerMatchedCallback = std::function<void(NMatchmakerMatchedPtr)>

MatchPresenceCallback

using NRtDefaultClientListener::MatchPresenceCallback = std::function<void(const NMatchPresenceEvent&)>

NotificationsCallback

using NRtDefaultClientListener::NotificationsCallback = std::function<void(const NNotificationList&)>

PartyCallback

using NRtDefaultClientListener::PartyCallback = std::function<void(const NParty&)>

PartyClosedCallback

using NRtDefaultClientListener::PartyClosedCallback = std::function<void(const NPartyClose&)>

PartyDataCallback

using NRtDefaultClientListener::PartyDataCallback = std::function<void(const NPartyData&)>

PartyJoinRequestCallback

using NRtDefaultClientListener::PartyJoinRequestCallback = std::function<void(const NPartyJoinRequest&)>

PartyLeaderCallback

using NRtDefaultClientListener::PartyLeaderCallback = std::function<void(const NPartyLeader&)>

PartyMatchmakerTicketCallback

using NRtDefaultClientListener::PartyMatchmakerTicketCallback = std::function<void(const NPartyMatchmakerTicket&)>

PartyPresenceCallback

using NRtDefaultClientListener::PartyPresenceCallback = std::function<void(const NPartyPresenceEvent&)>

StatusPresenceCallback

using NRtDefaultClientListener::StatusPresenceCallback = std::function<void(const NStatusPresenceEvent&)>

StreamDataCallback

using NRtDefaultClientListener::StreamDataCallback = std::function<void(const NStreamData&)>

StreamPresenceCallback

using NRtDefaultClientListener::StreamPresenceCallback = std::function<void(const NStreamPresenceEvent&)>

Member Function Documentation

onChannelMessage()

void NRtDefaultClientListener::onChannelMessage ( const NChannelMessage &  message )

inlineoverrideprotectedvirtual

Called when a new channel message has been received.

Parameters

message

The NChannelMessage received.

Reimplemented from NRtClientListenerInterface.

onChannelPresence()

void NRtDefaultClientListener::onChannelPresence ( const NChannelPresenceEvent &  presence )

inlineoverrideprotectedvirtual

Called when a new channel presence update has been received.

Parameters

presence

The NChannelPresenceEvent received.

Reimplemented from NRtClientListenerInterface.

onConnect()

void NRtDefaultClientListener::onConnect ( )

inlineoverrideprotectedvirtual

Called when the client socket has been connected.

Reimplemented from NRtClientListenerInterface.

onDisconnect()

void NRtDefaultClientListener::onDisconnect ( const NRtClientDisconnectInfo &  info )

inlineoverrideprotectedvirtual

Called when the client socket disconnects.

Parameters

info	The NRtClientDisconnectInfo.

Reimplemented from NRtClientListenerInterface.

onError()

void NRtDefaultClientListener::onError ( const NRtError &  error )

inlineoverrideprotectedvirtual

Called when the client receives an error.

Parameters

error

The NRtError received.

Reimplemented from NRtClientListenerInterface.

onMatchData()

void NRtDefaultClientListener::onMatchData ( const NMatchData &  matchData )

inlineoverrideprotectedvirtual

Called when a new match data is received.

Parameters

matchData

The NMatchData received.

Reimplemented from NRtClientListenerInterface.

onMatchmakerMatched()

void NRtDefaultClientListener::onMatchmakerMatched ( NMatchmakerMatchedPtr  matched )

inlineoverrideprotectedvirtual

Called when a matchmaking has found a match.

Parameters

matched

The NMatchmakerMatched received.

Reimplemented from NRtClientListenerInterface.

onMatchPresence()

void NRtDefaultClientListener::onMatchPresence ( const NMatchPresenceEvent &  matchPresence )

inlineoverrideprotectedvirtual

Called when a new match presence update is received.

Parameters

matchPresence

The NMatchPresenceEvent received.

Reimplemented from NRtClientListenerInterface.

onNotifications()

void NRtDefaultClientListener::onNotifications ( const NNotificationList &  notifications )

inlineoverrideprotectedvirtual

Called when the client receives new notifications.

Parameters

notifications

The list of NNotification received.

Reimplemented from NRtClientListenerInterface.

onParty()

void NRtDefaultClientListener::onParty ( const NParty &  party )

inlineoverrideprotectedvirtual

Called when occur when the current user's invitation request is accepted by the party leader of a closed party.

Parameters

party

the NParty joined by the user.

Reimplemented from NRtClientListenerInterface.

onPartyClosed()

void NRtDefaultClientListener::onPartyClosed ( const NPartyClose &  partyCloseEvent )

inlineoverrideprotectedvirtual

Called when either the user's party closes or the user is removed from the party.

Parameters

partyClosedEvent

The NPartyClose received.

Reimplemented from NRtClientListenerInterface.

onPartyData()

void NRtDefaultClientListener::onPartyData ( const NPartyData &  partyData )

inlineoverrideprotectedvirtual

Called when the user receives custom party data.

Parameters

partyData

The NPartyData received.

Reimplemented from NRtClientListenerInterface.

onPartyJoinRequest()

void NRtDefaultClientListener::onPartyJoinRequest ( const NPartyJoinRequest &  partyJoinRequest )

inlineoverrideprotectedvirtual

Called when the user receives a request to join the party.

Parameters

party

The NPartyJoinRequest received.

Reimplemented from NRtClientListenerInterface.

onPartyLeader()

void NRtDefaultClientListener::onPartyLeader ( const NPartyLeader &  partyLeader )

inlineoverrideprotectedvirtual

Called when the user's party leader has changed.

Parameters

partyLeader

the new NPartyLeader.

Reimplemented from NRtClientListenerInterface.

onPartyMatchmakerTicket()

void NRtDefaultClientListener::onPartyMatchmakerTicket ( const NPartyMatchmakerTicket &  ticket )

inlineoverrideprotectedvirtual

Called when the user receives a new party matchmaker ticket.

Parameters

ticket

the NPartyMatchmakerTicket received upon entering the matchmaking system.

Reimplemented from NRtClientListenerInterface.

onPartyPresence()

void NRtDefaultClientListener::onPartyPresence ( const NPartyPresenceEvent &  presenceEvent )

inlineoverrideprotectedvirtual

Called when a presence event occurs within the party. Received a new presence event in the party.

Parameters

presenceEvent

the NPNPartyPresenceEvent received.

Reimplemented from NRtClientListenerInterface.

onStatusPresence()

void NRtDefaultClientListener::onStatusPresence ( const NStatusPresenceEvent &  presence )

inlineoverrideprotectedvirtual

Called when the client receives status presence updates.

Parameters

presence

Updated NStatusPresenceEvent presence.

Reimplemented from NRtClientListenerInterface.

onStreamData()

void NRtDefaultClientListener::onStreamData ( const NStreamData &  data )

inlineoverrideprotectedvirtual

Called when the client receives stream data.

Parameters

data	Stream NStreamData data received.

Reimplemented from NRtClientListenerInterface.

onStreamPresence()

void NRtDefaultClientListener::onStreamPresence ( const NStreamPresenceEvent &  presence )

inlineoverrideprotectedvirtual

Called when the client receives stream presence updates.

Parameters

presence

Updated NStreamPresenceEvent presence.

Reimplemented from NRtClientListenerInterface.

setChannelMessageCallback()

void NRtDefaultClientListener::setChannelMessageCallback ( ChannelMessageCallback  callback )

inline

setChannelPresenceCallback()

void NRtDefaultClientListener::setChannelPresenceCallback ( ChannelPresenceCallback  callback )

inline

setConnectCallback()

void NRtDefaultClientListener::setConnectCallback ( ConnectCallback  callback )

inline

setDisconnectCallback()

void NRtDefaultClientListener::setDisconnectCallback ( DisconnectCallback  callback )

inline

setErrorCallback()

void NRtDefaultClientListener::setErrorCallback ( ErrorCallback  callback )

inline

setMatchDataCallback()

void NRtDefaultClientListener::setMatchDataCallback ( MatchDataCallback  callback )

inline

setMatchmakerMatchedCallback()

void NRtDefaultClientListener::setMatchmakerMatchedCallback ( MatchmakerMatchedCallback  callback )

inline

setMatchPresenceCallback()

void NRtDefaultClientListener::setMatchPresenceCallback ( MatchPresenceCallback  callback )

inline

setNotificationsCallback()

void NRtDefaultClientListener::setNotificationsCallback ( NotificationsCallback  callback )

inline

setPartyCallback()

void NRtDefaultClientListener::setPartyCallback ( PartyCallback  callback )

inline

setPartyCloseCallback()

void NRtDefaultClientListener::setPartyCloseCallback ( PartyClosedCallback  callback )

inline

setPartyDataCallback()

void NRtDefaultClientListener::setPartyDataCallback ( PartyDataCallback  callback )

inline

setPartyJoinRequestCallback()

void NRtDefaultClientListener::setPartyJoinRequestCallback ( PartyJoinRequestCallback  callback )

inline

setPartyLeaderCallback()

void NRtDefaultClientListener::setPartyLeaderCallback ( PartyLeaderCallback  callback )

inline

setPartyMatchmakerTicketCallback()

void NRtDefaultClientListener::setPartyMatchmakerTicketCallback ( PartyMatchmakerTicketCallback  callback )

inline

setPartyPresenceCallback()

void NRtDefaultClientListener::setPartyPresenceCallback ( PartyPresenceCallback  callback )

inline

setStatusPresenceCallback()

void NRtDefaultClientListener::setStatusPresenceCallback ( StatusPresenceCallback  callback )

inline

setStreamDataCallback()

void NRtDefaultClientListener::setStreamDataCallback ( StreamDataCallback  callback )

inline

setStreamPresenceCallback()

void NRtDefaultClientListener::setStreamPresenceCallback ( StreamPresenceCallback  callback )

inline

Member Data Documentation

_channelMessageCallback

ChannelMessageCallback NRtDefaultClientListener::_channelMessageCallback

protected

_channelPresenceCallback

ChannelPresenceCallback NRtDefaultClientListener::_channelPresenceCallback

protected

_connectCallback

ConnectCallback NRtDefaultClientListener::_connectCallback

protected

_disconnectCallback

DisconnectCallback NRtDefaultClientListener::_disconnectCallback

protected

_errorCallback

ErrorCallback NRtDefaultClientListener::_errorCallback

protected

_matchDataCallback

MatchDataCallback NRtDefaultClientListener::_matchDataCallback

protected

_matchmakerMatchedCallback

MatchmakerMatchedCallback NRtDefaultClientListener::_matchmakerMatchedCallback

protected

_matchPresenceCallback

MatchPresenceCallback NRtDefaultClientListener::_matchPresenceCallback

protected

_notificationsCallback

NotificationsCallback NRtDefaultClientListener::_notificationsCallback

protected

_partyCallback

PartyCallback NRtDefaultClientListener::_partyCallback

protected

_partyClosedCallback

PartyClosedCallback NRtDefaultClientListener::_partyClosedCallback

protected

_partyDataCallback

PartyDataCallback NRtDefaultClientListener::_partyDataCallback

protected

_partyJoinRequestCallback

PartyJoinRequestCallback NRtDefaultClientListener::_partyJoinRequestCallback

protected

_partyLeaderCallback

PartyLeaderCallback NRtDefaultClientListener::_partyLeaderCallback

protected

_partyMatchmakerTicketCallback

PartyMatchmakerTicketCallback NRtDefaultClientListener::_partyMatchmakerTicketCallback

protected

_partyPresenceCallback

PartyPresenceCallback NRtDefaultClientListener::_partyPresenceCallback

protected

_statusPresenceCallback

StatusPresenceCallback NRtDefaultClientListener::_statusPresenceCallback

protected

_streamDataCallback

StreamDataCallback NRtDefaultClientListener::_streamDataCallback

protected

_streamPresenceCallback

StreamPresenceCallback NRtDefaultClientListener::_streamPresenceCallback

protected

---

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

• NRtDefaultClientListener.h