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

The end message is sent from the server to an agent to indicate that the session has ended and that they should now disconnect. More...

#include <tt/io/End.h>

Inheritance diagram for tt::End:
Collaboration diagram for tt::End:

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 session
 The ID of the session, or empty if the session was not logged.

Detailed Description

The end message is sent from the server to an agent to indicate that the session has ended and that they should now disconnect.

If the server is logging sessions, this message contains ID of the logged session.

Author
Gage Birchmeier

Member Function Documentation

◆ toString()

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

Returns a string representation of this object.

Returns
a string describing this object

Reimplemented from tt::Message.

◆ type()

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

Type used for JSON deserialization.

Implements tt::Message.


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