libftc
Métodos Públicos
Referência da Classe ftc_abi_safe

Classe que representa a API de acesso a um arquivo remoto que utiliza pImpl para estabilidade de ABI. Mais...

#include <ftc_abi_safe.h>

Lista de todos os Membros.

Métodos Públicos

TEC_FTC_DECL ftc_abi_safe (const char *id, bool writable, const char *host, unsigned short port, const char *accessKey)
 Construtor.
TEC_FTC_DECL ~ftc_abi_safe ()
 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 unsigned long long getPosition () const
 Retorna a atual posição do 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 unsigned long long getSize () const
 Retorna o tamanho atual do arquivo.
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 que utiliza pImpl para estabilidade de ABI.

Definição na linha 11 do arquivo ftc_abi_safe.h.


Construtores & Destrutores

ftc_abi_safe::ftc_abi_safe ( const char *  id,
bool  writable,
const char *  host,
unsigned short  port,
const char *  accessKey 
)

Construtor.

Parâmetros:
idIdentificador do arquivo.
writableIndica se o arquivo deve ser aberto para leitura.
hostEndereço do servidor.
portPorta TCP do servidor.
accessKeyChave de acesso ao arquivo.

Definição na linha 26 do arquivo ftc_abi_safe.cpp.

Destrutor.

Definição na linha 37 do arquivo ftc_abi_safe.cpp.


Métodos

Fecha o arquivo.

Definição na linha 52 do arquivo ftc_abi_safe.cpp.

unsigned long long ftc_abi_safe::getPosition ( ) const

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 62 do arquivo ftc_abi_safe.cpp.

unsigned long long ftc_abi_safe::getSize ( ) const

Retorna o tamanho atual do arquivo.

Retorna:
O numero de bytes que o arquivo possui.

Definição na linha 72 do arquivo ftc_abi_safe.cpp.

Indica se o arquivo está aberto.

Retorna:
Verdadeiro se o arquivo estiver aberto

Definição na linha 47 do arquivo ftc_abi_safe.cpp.

void ftc_abi_safe::open ( bool  readonly)

Abre o arquivo remoto.

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

Definição na linha 42 do arquivo ftc_abi_safe.cpp.

unsigned long long ftc_abi_safe::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 77 do arquivo ftc_abi_safe.cpp.

void ftc_abi_safe::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 57 do arquivo ftc_abi_safe.cpp.

void ftc_abi_safe::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 67 do arquivo ftc_abi_safe.cpp.

unsigned long long ftc_abi_safe::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 87 do arquivo ftc_abi_safe.cpp.

unsigned long long ftc_abi_safe::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 82 do arquivo ftc_abi_safe.cpp.


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