eris  1.4.0
A WorldForge client library.
Eris::TransferInfo Class Reference

#include <TransferInfo.h>

Public Member Functions

 TransferInfo (std::string host, int port, std::string key, 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)

Definition at line 16 of file TransferInfo.h.

Constructor & Destructor Documentation

◆ TransferInfo()

Eris::TransferInfo::TransferInfo ( std::string  host,
int  port,
std::string  key,
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

Definition at line 9 of file TransferInfo.cpp.

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

Definition at line 19 of file TransferInfo.cpp.

◆ getPort()

int Eris::TransferInfo::getPort ( ) const

Get the connection port of the transfer destination server.

Returns
The connection port of the transfer destination server

Definition at line 23 of file TransferInfo.cpp.

◆ 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

Definition at line 31 of file TransferInfo.cpp.

◆ 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

Definition at line 27 of file TransferInfo.cpp.


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