NRtClientListenerInterface Class Reference

#include <NRtClientListenerInterface.h>

Inheritance diagram for NRtClientListenerInterface:

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

Detailed Description

A listener for receiving NRtClientInterface events.

Constructor & Destructor Documentation

~NRtClientListenerInterface()

virtual NRtClientListenerInterface::~NRtClientListenerInterface ( )

inlinevirtual

Member Function Documentation

onChannelMessage()

virtual void NRtClientListenerInterface::onChannelMessage ( const NChannelMessage &  message )

inlinevirtual

Called when a new channel message has been received.

Parameters

message

The NChannelMessage received.

Reimplemented in NRtDefaultClientListener.

onChannelPresence()

virtual void NRtClientListenerInterface::onChannelPresence ( const NChannelPresenceEvent &  presence )

inlinevirtual

Called when a new channel presence update has been received.

Parameters

presence

The NChannelPresenceEvent received.

Reimplemented in NRtDefaultClientListener.

onConnect()

virtual void NRtClientListenerInterface::onConnect ( )

inlinevirtual

Called when the client socket has been connected.

Reimplemented in NRtDefaultClientListener.

onDisconnect()

virtual void NRtClientListenerInterface::onDisconnect ( const NRtClientDisconnectInfo &  info )

inlinevirtual

Called when the client socket disconnects.

Parameters

info	The NRtClientDisconnectInfo.

Reimplemented in NRtDefaultClientListener.

onError()

virtual void NRtClientListenerInterface::onError ( const NRtError &  error )

inlinevirtual

Called when the client receives an error.

Parameters

error

The NRtError received.

Reimplemented in NRtDefaultClientListener.

onMatchData()

virtual void NRtClientListenerInterface::onMatchData ( const NMatchData &  matchData )

inlinevirtual

Called when a new match data is received.

Parameters

matchData

The NMatchData received.

Reimplemented in NRtDefaultClientListener.

onMatchmakerMatched()

virtual void NRtClientListenerInterface::onMatchmakerMatched ( NMatchmakerMatchedPtr  matched )

inlinevirtual

Called when a matchmaking has found a match.

Parameters

matched

The NMatchmakerMatched received.

Reimplemented in NRtDefaultClientListener.

onMatchPresence()

virtual void NRtClientListenerInterface::onMatchPresence ( const NMatchPresenceEvent &  matchPresence )

inlinevirtual

Called when a new match presence update is received.

Parameters

matchPresence

The NMatchPresenceEvent received.

Reimplemented in NRtDefaultClientListener.

onNotifications()

virtual void NRtClientListenerInterface::onNotifications ( const NNotificationList &  notifications )

inlinevirtual

Called when the client receives new notifications.

Parameters

notifications

The list of NNotification received.

Reimplemented in NRtDefaultClientListener.

onParty()

virtual void NRtClientListenerInterface::onParty ( const NParty &  party )

inlinevirtual

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 in NRtDefaultClientListener.

onPartyClosed()

virtual void NRtClientListenerInterface::onPartyClosed ( const NPartyClose &  partyCloseEvent )

inlinevirtual

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

Parameters

partyClosedEvent

The NPartyClose received.

Reimplemented in NRtDefaultClientListener.

onPartyData()

virtual void NRtClientListenerInterface::onPartyData ( const NPartyData &  partyData )

inlinevirtual

Called when the user receives custom party data.

Parameters

partyData

The NPartyData received.

Reimplemented in NRtDefaultClientListener.

onPartyJoinRequest()

virtual void NRtClientListenerInterface::onPartyJoinRequest ( const NPartyJoinRequest &  partyJoinRequest )

inlinevirtual

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

Parameters

party

The NPartyJoinRequest received.

Reimplemented in NRtDefaultClientListener.

onPartyLeader()

virtual void NRtClientListenerInterface::onPartyLeader ( const NPartyLeader &  partyLeader )

inlinevirtual

Called when the user's party leader has changed.

Parameters

partyLeader

the new NPartyLeader.

Reimplemented in NRtDefaultClientListener.

onPartyMatchmakerTicket()

virtual void NRtClientListenerInterface::onPartyMatchmakerTicket ( const NPartyMatchmakerTicket &  ticket )

inlinevirtual

Called when the user receives a new party matchmaker ticket.

Parameters

ticket

the NPartyMatchmakerTicket received upon entering the matchmaking system.

Reimplemented in NRtDefaultClientListener.

onPartyPresence()

virtual void NRtClientListenerInterface::onPartyPresence ( const NPartyPresenceEvent &  presenceEvent )

inlinevirtual

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

Parameters

presenceEvent

the NPNPartyPresenceEvent received.

Reimplemented in NRtDefaultClientListener.

onStatusPresence()

virtual void NRtClientListenerInterface::onStatusPresence ( const NStatusPresenceEvent &  presence )

inlinevirtual

Called when the client receives status presence updates.

Parameters

presence

Updated NStatusPresenceEvent presence.

Reimplemented in NRtDefaultClientListener.

onStreamData()

virtual void NRtClientListenerInterface::onStreamData ( const NStreamData &  data )

inlinevirtual

Called when the client receives stream data.

Parameters

data	Stream NStreamData data received.

Reimplemented in NRtDefaultClientListener.

onStreamPresence()

virtual void NRtClientListenerInterface::onStreamPresence ( const NStreamPresenceEvent &  presence )

inlinevirtual

Called when the client receives stream presence updates.

Parameters

presence

Updated NStreamPresenceEvent presence.

Reimplemented in NRtDefaultClientListener.

---

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

• NRtClientListenerInterface.h