Eris  1.4.0
Public Member Functions | List of all members
Eris::TransferInfo Class Reference

A TransferInfo object represents the encapsulation of various data required to successfully transfer a character from one server to another. More...

#include <TransferInfo.h>

Public Member Functions

 TransferInfo (const std::string &host, int port, const std::string &key, const std::string &id)
 Ctor. More...
 
const std::string & getHost () const
 Get the hostname of the transfer destination server. More...
 
int getPort () const
 Get the connection port of the transfer destination server. More...
 
const std::string & getPossessKey () const
 Get the one-time generated possess key (used for claiming ownership) More...
 
const std::string & getPossessEntityId () const
 Get the entity ID of the transferred character on the destination server. More...
 

Detailed Description

A TransferInfo object represents the encapsulation of various data required to successfully transfer a character from one server to another.

The data includes the new host and port of the transfer destination as well as fields to authenticate the client as the owner of the transferred character. A TransferInfo object is normally created during the servers reply to a transfer request initiated by the client (eg. a teleport request)

Constructor & Destructor Documentation

◆ TransferInfo()

Eris::TransferInfo::TransferInfo ( const std::string &  host,
int  port,
const std::string &  key,
const std::string &  id 
)

Ctor.

Parameters
hostThe transfer destination servers hostname
portThe transfer destination servers port
keyRandomized key used to claim ownership over transferred character
idEntity ID of transferred character on destination server

Member Function Documentation

◆ getHost()

const std::string & Eris::TransferInfo::getHost ( ) const

Get the hostname of the transfer destination server.

Returns
The hostname of the transfer destination

◆ getPort()

int Eris::TransferInfo::getPort ( ) const

Get the connection port of the transfer destination server.

Returns
The connection port of the transfer destination server

◆ getPossessEntityId()

const std::string & Eris::TransferInfo::getPossessEntityId ( ) const

Get the entity ID of the transferred character on the destination server.

Returns
The entity ID of the transferred character on the destination server

◆ getPossessKey()

const std::string & Eris::TransferInfo::getPossessKey ( ) const

Get the one-time generated possess key (used for claiming ownership)

Returns
The possess key to claim ownership of a transferred character

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