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

Representa uma chave de acesso a um canal de dados. Mais...

#include <AccessKey.h>

Lista de todos os Membros.

Métodos Públicos

 AccessKey ()
 Construtor com geração automática da chave de acesso.
 AccessKey (AccessKey const &key)
 Construtor de cópia.
 AccessKey (unsigned char *new_key, uint8_t size, bool copy)
 Construtor com chave de acesso própria.
 AccessKey (const std::vector< uint8_t > &new_key)
 Construtor com chave de acesso própria.
 ~AccessKey ()
 Destrutor.
const unsigned char * key () const
 Retorna o buffer da chave de acesso como um array de bytes.
uint8_t size () const
 Retorna o tamanho da chave de acesso em bytes.
AccessKeyoperator= (AccessKey const &)
bool operator== (AccessKey const &) const
bool operator<= (AccessKey const &) const
bool operator>= (AccessKey const &) const
bool operator< (AccessKey const &) const
bool operator> (AccessKey const &) const

Atributos Estáticos Públicos

static const uint8_t DEFAULT_SIZE = 16U
 Tamanho padrão de uma chave de acesso.
static const uint8_t MAX_SIZE = 255U
 Tamanho máximo que uma chave de acesso pode ter.


Descrição Detalhada

Representa uma chave de acesso a um canal de dados.

Autor:
Tecgraf/PUC-Rio
A classe AccessKey contém a chave de acesso que identificará unicamente um canal de dados oferecido pelo servidor FTC. Um cliente FTC utiliza essa chave de acesso para abrir o canal de dados e assim então executar as operações no canal.

A chave de acesso pode ser gerada automaticamente. Neste caso, a mesma é preenchida com bytes aleatórios utilizando uma implementação de UUID - Universally Unique Identifiers). Para isso, crie uma instância de AccessKey sem passar nenhum parâmetro. Do contrário, é possível informar uma chave de acesso própria passando um array de bytes como parâmetro.

A chave de acesso pode ter um tamanho de no máximo MAX_SIZE bytes. Já a chave de acesso gerada automaticamente tem um tamanho fixo de DEFAULT_SIZE bytes.


Construtores & Destrutores

tecgraf::ftc::v1_04_01::AccessKey::AccessKey (  ) 

Construtor com geração automática da chave de acesso.

Cria uma chave de acesso com um identificador gerado automaticamente com tamanho fixo de DEFAULT_SIZE bytes.

tecgraf::ftc::v1_04_01::AccessKey::AccessKey ( AccessKey const &  key  ) 

Construtor de cópia.

Parâmetros:
key Chave de Acesso

tecgraf::ftc::v1_04_01::AccessKey::AccessKey ( unsigned char *  new_key,
uint8_t  size,
bool  copy 
)

Construtor com chave de acesso própria.

Cria uma chave de acesso passando um identificador próprio. É possível manter uma referência para o array de bytes ou fazer uma cópia em memória do mesmo.

Parâmetros:
new_key Chave de acesso como buffer.
size Tamanho da chave de acesso.
copy Indica se uma cópia do buffer dever ser realizada.

tecgraf::ftc::v1_04_01::AccessKey::AccessKey ( const std::vector< uint8_t > &  new_key  ) 

Construtor com chave de acesso própria.

Cria uma chave de acesso passando um identificador próprio.

Parâmetros:
new_key Chave de acesso como array de bytes.


Métodos

const unsigned char* tecgraf::ftc::v1_04_01::AccessKey::key (  )  const

Retorna o buffer da chave de acesso como um array de bytes.

Retorna:
Retorna o buffer da chave de acesso como um array de bytes.

uint8_t tecgraf::ftc::v1_04_01::AccessKey::size (  )  const

Retorna o tamanho da chave de acesso em bytes.

Retorna:
Retorna o tamanho da chave de acesso em bytes


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