TT Client Library 1.0.0
C++ library for Tandem Tales clients.
Loading...
Searching...
No Matches
tt::Connect Class Reference

The connect message is sent from the server to a client as soon as the agent connects to give details about which story worlds and agents are available for play. More...

#include <tt/io/Connect.h>

Inheritance diagram for tt::Connect:
Collaboration diagram for tt::Connect:

Classes

class  Available
 Advertises that a specific story world and agent pair is waiting for a match. More...

Public Member Functions

std::string toString () const override
 Returns a string representation of this object.
std::string type () const override
 Type used for JSON deserialization.
Public Member Functions inherited from tt::Message
 Message ()
 Constructs a message.
const Client * getClient () const
 Returns the tt::Client who sent this message, or null if this message was sent by the server.
void setClient (const Client *client)
 Sets the tt::Client who sent this message.

Public Attributes

std::string version
 The server's software version.
std::vector< Entry > worlds
 A list of entries giving the names and descriptions of the publicly listed worlds available on this server.
std::vector< Entry > agents
 A list of entries giving the names and descriptions of the publicly listed agents available on this server.
std::vector< Available > available
 A list of available world/agent pairs that lets an agent know whether a specific combination of a story world and agent is immediately available for play.

Detailed Description

The connect message is sent from the server to a client as soon as the agent connects to give details about which story worlds and agents are available for play.

Author
Gage Birchmeier

Member Function Documentation

◆ toString()

std::string tt::Connect::toString ( ) const
overridevirtual

Returns a string representation of this object.

Returns
a string describing this object

Reimplemented from tt::Message.

◆ type()

std::string tt::Connect::type ( ) const
inlineoverridevirtual

Type used for JSON deserialization.

Implements tt::Message.


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