Referência da Classe tecgraf::ftc::v1_04_01::DataChannelInfo

Representa informações sobre o acesso a um canal de dados. Mais...

#include <DataChannelInfo.h>

Lista de todos os Membros.

Métodos Públicos

 DataChannelInfo (const AccessKey *const access_key, void *requester, const std::string &data_id, const std::string &hostname, uint16_t port, bool use_transfer_to)
 Cria informações sobre o acesso a um canal de dados.
 ~DataChannelInfo ()
 Destrutor.
const std::string & hostname () const
 Obtém o endereço da máquina do servidor.
uint16_t port () const
 Obtém a porta da máquina do servidor.
const AccessKeyaccess_key () const
 Obtém a chave de acesso.
const std::string & data_id () const
 Obtém o identificador do canal de dados.
void * requester () const
 Obtém o dado de utilização livre para o usuário da API.
bool use_transfer_to () const
 Informa a possibilidade de utilização do método TransferTo se o canal suportar.
bool check_timeout (const uint64_t &timeout_ms) const
 Informa se essa requisição já expirou passado o timeout.


Descrição Detalhada

Representa informações sobre o acesso a um canal de dados.

Veja também:
DataChannelInfo_ptr
O servidor FTC retorna as informações de um registro de uma requisição para um canal de dados por essa classe. As informações contidas nessa classe devem de alguma maneira serem enviadas para o cliente FTC (Isto está fora do escopo do FTC).


Construtores & Destrutores

tecgraf::ftc::v1_04_01::DataChannelInfo::DataChannelInfo ( const AccessKey *const   access_key,
void *  requester,
const std::string &  data_id,
const std::string &  hostname,
uint16_t  port,
bool  use_transfer_to 
)

Cria informações sobre o acesso a um canal de dados.

O servidor FTC utiliza esse construtor no momento que é registrado uma requisição para um canal de dados.

Parâmetros:
access_key A chave de acesso.
requester Dado para utilização livre do usuário da API.
hostname O endereço da máquina do servidor.
port A porta da máquina do servidor.
data_id O identificador do canal de dados.
use_transfer_to Informa a possibilidade de utilização do método TransferTo caso o canal suporte.


Métodos

const AccessKey* tecgraf::ftc::v1_04_01::DataChannelInfo::access_key (  )  const

Obtém a chave de acesso.

Retorna:
A chave de acesso.

bool tecgraf::ftc::v1_04_01::DataChannelInfo::check_timeout ( const uint64_t &  timeout_ms  )  const

Informa se essa requisição já expirou passado o timeout.

Parâmetros:
timeout_ms Timeout em milisegundos.
Retorna:
true se essa requisição já expirou.

const std::string& tecgraf::ftc::v1_04_01::DataChannelInfo::data_id (  )  const

Obtém o identificador do canal de dados.

Retorna:
O identificador do canal de dados.

const std::string& tecgraf::ftc::v1_04_01::DataChannelInfo::hostname (  )  const

Obtém o endereço da máquina do servidor.

Retorna:
O endereço da máquina do servidor.

uint16_t tecgraf::ftc::v1_04_01::DataChannelInfo::port (  )  const

Obtém a porta da máquina do servidor.

Retorna:
A porta da máquina do servidor.

void* tecgraf::ftc::v1_04_01::DataChannelInfo::requester (  )  const

Obtém o dado de utilização livre para o usuário da API.

Retorna:
O dado de utilização livre para o usuário da API.

bool tecgraf::ftc::v1_04_01::DataChannelInfo::use_transfer_to (  )  const

Informa a possibilidade de utilização do método TransferTo se o canal suportar.

Retorna:
Se libera a utilização do método TransferTo caso o canal suporte.


A documentação para esta classe foi gerada a partir do seguinte arquivo:
Gerado em Mon Feb 3 03:15:08 2014 para FTC[C++] por  doxygen 1.4.7