libftc
Métodos Públicos
Referência da Estrutura ftc

Classe que representa a API de acesso a um arquivo remoto. Mais...

#include <ftc.h>

Lista de todos os Membros.

Métodos Públicos

TEC_FTC_DECL ftc (const char *id, const char id_size, bool writable, const char *host, unsigned short port, const char *accessKey, const char key_size)
 Construtor.
TEC_FTC_DECL ~ftc ()
 Destrutor.
TEC_FTC_DECL void open (bool readonly)
 Abre o arquivo remoto.
TEC_FTC_DECL bool isOpen ()
 Indica se o arquivo está aberto.
TEC_FTC_DECL void close ()
 Fecha o arquivo.
TEC_FTC_DECL void setPosition (unsigned long long position)
 Posiciona o cursor de leitura no arquivo.
TEC_FTC_DECL void setSize (unsigned long long size)
 Define o tamanho do arquivo. Pode ser usado para alocar um espaço ou truncar o arquivo.
TEC_FTC_DECL void setReadBufferSize (unsigned long long size)
 Define o tamanho do buffer de leitura utilizado na leitura do arquivo.
TEC_FTC_DECL unsigned long long getPosition ()
 Retorna a atual posição do cursor de leitura no arquivo.
TEC_FTC_DECL unsigned long long getSize () const
 Retorna o tamanho atual do arquivo.
TEC_FTC_DECL unsigned long long getReadBufferSize ()
 Retorna o tamanho atual do buffer de leitura.
TEC_FTC_DECL unsigned long long read (char *data, unsigned long long nbytes, unsigned long long position)
 Le uma quantidade de bytes a partir de uma dada posição.
TEC_FTC_DECL unsigned long long write (const char *data, unsigned long long nbytes, unsigned long long position)
 Escreve uma quantidade de bytes no arquivo.
TEC_FTC_DECL unsigned long long transferTo (unsigned long long position, unsigned long long nbytes, FILE *fd, char *buffer)
 Transfere os dados do arquivo remoto diretamente para um arquivo local.

Descrição Detalhada

Classe que representa a API de acesso a um arquivo remoto.

Definição na linha 20 do arquivo ftc.h.


Construtores & Destrutores

ftc::ftc ( const char *  id,
const char  id_size,
bool  writable,
const char *  host,
unsigned short  port,
const char *  accessKey,
const char  key_size 
)

Construtor.

Parâmetros:
idArray contendo o identificador do arquivo.
id_sizeTamanho do array que contem o identificador do arquivo.
writableIndica se o arquivo deve ser aberto para leitura.
hostEndereço do servidor.
portPorta TCP do servidor.
accessKeyArray contendo a chave de acesso ao arquivo.
key_sizeTamanho do array que contem a chave de acesso.

Definição na linha 312 do arquivo ftc.cpp.

ftc::~ftc ( )

Destrutor.

Definição na linha 394 do arquivo ftc.cpp.


Métodos

void ftc::close ( )

Fecha o arquivo.

Definição na linha 403 do arquivo ftc.cpp.

unsigned long long ftc::getPosition ( )

Retorna a atual posição do cursor de leitura no arquivo.

Retorna:
Posição a partir no inicio do arquivo em bytes.

Definição na linha 441 do arquivo ftc.cpp.

unsigned long long ftc::getReadBufferSize ( )

Retorna o tamanho atual do buffer de leitura.

Retorna:
Tamanho do buffer em bytes.

Definição na linha 448 do arquivo ftc.cpp.

unsigned long long ftc::getSize ( ) const

Retorna o tamanho atual do arquivo.

Retorna:
O numero de bytes que o arquivo possui.

Definição na linha 470 do arquivo ftc.cpp.

bool ftc::isOpen ( )

Indica se o arquivo está aberto.

Retorna:
Verdadeiro se o arquivo estiver aberto

Definição na linha 416 do arquivo ftc.cpp.

void ftc::open ( bool  readonly)

Abre o arquivo remoto.

Parâmetros:
readonlyIndica se o arquivo deve ser aberto apenas para leitura.

Definição na linha 326 do arquivo ftc.cpp.

unsigned long long ftc::read ( char *  data,
unsigned long long  nbytes,
unsigned long long  position 
)

Le uma quantidade de bytes a partir de uma dada posição.

Parâmetros:
dataPonteiro para o espaço onde os bytes lidos serão escritos.
nbytesQuantidades de bytes a serem lidos.
positionPosição inicial da leitura.
Retorna:
Retorna o numero de bytes lidos.

Definição na linha 477 do arquivo ftc.cpp.

void ftc::setPosition ( unsigned long long  position)

Posiciona o cursor de leitura no arquivo.

Parâmetros:
positionNumero de bytes a partir do inicio do arquivo.

Definição na linha 421 do arquivo ftc.cpp.

void ftc::setReadBufferSize ( unsigned long long  size)

Define o tamanho do buffer de leitura utilizado na leitura do arquivo.

Parâmetros:
sizeTamanho do buffer de leitura em bytes.

Definição na linha 437 do arquivo ftc.cpp.

void ftc::setSize ( unsigned long long  size)

Define o tamanho do arquivo. Pode ser usado para alocar um espaço ou truncar o arquivo.

Parâmetros:
sizeNovo tamanho do arquivo em bytes.

Definição na linha 453 do arquivo ftc.cpp.

unsigned long long ftc::transferTo ( unsigned long long  position,
unsigned long long  nbytes,
FILE *  fd,
char *  buffer 
)

Transfere os dados do arquivo remoto diretamente para um arquivo local.

Parâmetros:
positionPosição do cursor no arquivo remoto.
nbytesQuantidade de bytes a serem transferidos.
fdDescritor do arquivo local.
bufferDeprecado
Retorna:
Retorna o número de bytes escritos.

Definição na linha 613 do arquivo ftc.cpp.

unsigned long long ftc::write ( const char *  data,
unsigned long long  nbytes,
unsigned long long  position 
)

Escreve uma quantidade de bytes no arquivo.

Parâmetros:
dataPonteiro de onde os dados serão lidos.
nbytesQuantidade de bytes a serem escritos.
positionPosição inicial da escrita.
Retorna:
Retorna a quantidade de bytes escritos.

Definição na linha 542 do arquivo ftc.cpp.


A documentação para esta estrutura foi gerada a partir dos seguintes arquivos: