Pacotes Manual de referência

Transcrição

1 Pacotes Manual de referência 1 Gerado por Doxygen Fri Dec 1 22:55:

2

3 Conteúdo 1 Pacotes Índice dos namespaces Pacotes Lista de namespaces Pacotes Índice dos componentes Pacotes Lista de componentes Pacotes Índice dos ficheiros Pacotes Lista de ficheiros Pacotes Documentação dos namespaces Referencia ao namespace IPC Pacotes Documentação da classe Referencia à classe IPC::Erro Referencia à classe IPC::Mensageiro Pacotes Documentação do ficheiro Referencia ao ficheiro erros.h Referencia ao ficheiro ipc.h Referencia ao ficheiro mensageiro.c Referencia ao ficheiro mensageiro.h Referencia ao ficheiro mensageiro impl.h Referencia ao ficheiro string.h

4

5 Capítulo 1 Pacotes Índice dos namespaces 1.1 Pacotes Lista de namespaces Lista dos namespaces com uma breve descrição: IPC (Este espaço nominativo envolve todas as ferramentas da biblioteca IPC++)

6 2 Pacotes Índice dos namespaces

7 Capítulo 2 Pacotes Índice dos componentes 2.1 Pacotes Lista de componentes Lista da classes, estruturas, uniões e interfaces com uma breve descrição: IPC::Erro (Classe usada para as excepções do pacote IPC) IPC::Mensageiro (Classe cuja única instância (em cada processo) representa um mensageiro entre o processo em causa e um outro na mesma máquina)

8 4 Pacotes Índice dos componentes

9 Capítulo 3 Pacotes Índice dos ficheiros 3.1 Pacotes Lista de ficheiros Lista de todos os ficheiros com uma breve descrição: mensageiro.c string.h erros.h (Ficheiro de interface do módulo erros) ipc.h (Ficheiro de interface da biblioteca) mensageiro.h (Ficheiro de interface do módulo mensageiro) mensageiro impl.h

10 6 Pacotes Índice dos ficheiros

11 Capítulo 4 Pacotes Documentação dos namespaces 4.1 Referencia ao namespace IPC Este espaço nominativo envolve todas as ferramentas da biblioteca IPC++. Componentes class IPC::Erro class IPC::Mensageiro Descrição detalhada Este espaço nominativo envolve todas as ferramentas da biblioteca IPC++. A biblioteca IPC++ permite a utilização simplificada de comunicações entre processos (IPC, de Inter Process Communications). A biblioteca consiste de um pacote IPC (representado pelo espaço nominativo IPC) consistindo, para já, apenas no módulo fisico mensageiro e no módulo físico erros, com os correspondentes ficheiro de interface IPC/mensageiro.H e IPC/erros.H. Nesta documentação omite-se o prefixo IPC:: sempre que conveniente para facilitar a leitura, embora em rigor este seja necessário. Para construir um programa (neste caso teste ipc.c) que utilize estas biblioteca deve dar o seguinte comando: c++ -Wall -ansi -pedantic -g -o teste ipc teste ipc.c -lipc++ Os ficheiros fonte devem incluir o ficheiro de interface IPC/ipc.H, que por sua vez inclui os ficheiros de interface dos módulos físicos, ou incluir apenas o ficheiro de interface do módulo pretendido. Caso se pretenda instalar esta biblioteca noutro computador deve-se fazer o seguinte: 1. Importar os seguintes ficheiros: Pacotes-0.1.tar.gz

12 8 Pacotes Documentação dos namespaces Para importar no netscape basta fazer shift-clique no botão esquerdo do rato. 2. Dar os seguintes comandos: tar -zxf Pacotes-0.1.tar.gz cd Pacotes make su (inserir a senha [password] de administração da máquina) make install exit Autor(es): Manuel Menezes de Sequeira Versão: 0.1 Data: 2000

13 Capítulo 5 Pacotes Documentação da classe 5.1 Referencia à classe IPC::Erro Classe usada para as excepções do pacote IPC. #include IPC/erros.H Membros públicos Erro (string const& mensagem) Constrói excepção dada mensagem de erro. Erro () Constrói excepção usando mensagem de erro padrão correspondente ao último erro ocorrido. operator string const () const É possível converter as excepções IPC em cadeias de caracteres Descrição detalhada Classe usada para as excepções do pacote IPC. Definido na linha 13 do ficheiro erros.h Documentação do Construtor & Destrutor IPC::Erro::Erro (string const & mensagem) [inline] Constrói excepção dada mensagem de erro.

14 10 Pacotes Documentação da classe Definido na linha 16 do ficheiro erros.h IPC::Erro::Erro () [inline] Constrói excepção usando mensagem de erro padrão correspondente ao último erro ocorrido. Definido na linha 21 do ficheiro erros.h Documentação dos métodos IPC::Erro::operator string const () const [inline] É possível converter as excepções IPC em cadeias de caracteres. A cadeia devolvida por este operador inclui a mensagem de erro e um prefixo indicando a sua origem no pacote IPC. Definido na linha 27 do ficheiro erros.h. A documentação para esta classe foi gerada a partir do seguinte ficheiro: erros.h

15 5.2 Referencia à classe IPC::Mensageiro Referencia à classe IPC::Mensageiro Classe cuja única instância (em cada processo) representa um mensageiro entre o processo em causa e um outro na mesma máquina. #include IPC/mensageiro.H Membros públicos Mensageiro (key t const chave = getuid()) Contrutor de um mensageiro. Mensageiro () Destrutor. string meuidentificador () Devolve um identificador único para o processo, que consiste no nome do utilizador seguido do número do processo. string identificadordooutro () Devolve o identificador único do outro processo, com o qual o corrente está emparelhado através do mensageiro. string stringrecebida () Devolve uma cadeia de caracteres recebida do outro. int intrecebido () Devolve um inteiro recebido do outro. char charrecebido () Devolve um caractere recebido. void envia (string const& mensagem) Envia uma cadeia de caracteres ao outro. void envia (int const valor) Envia um inteiro ao outro. void envia (char const c) Envia um caractere ao outro Descrição detalhada Classe cuja única instância (em cada processo) representa um mensageiro entre o processo em causa e um outro na mesma máquina.

16 12 Pacotes Documentação da classe Esta classe é um solitão! A ideia é que um processo com uma instância desta classe fica em comunicação com outro com outra instância da mesma classe. A selecção do outro processo é feita automaticamente, de acordo com as disponibilidades. A ideia é permitir a comunicação entre dois processos do mesmo jogo, sendo que os jogadores não têm controlo sobre que será o seu opositor. Nas descrições usa-se o termo eu para indicar o processo corrente, e outro para indicar o processo a que o eu está emparelhado pelo mensageiro. A comunicação faz-se enviando e recebendo mensagens. As mensagens enviadas e recebidas são, por enquanto, de apenas três tipos: char, int e string. Não existe, para já, nenhuma forma de indagar se há alguma mensagem disponível para ser recebida e muito menos saber o seu tipo. O protocolo entre os processos é que tem de garantir que os processos recebem tantas mensagens quantas as enviadas pelo outro, enviam tantas mensagens quantas as recebidas pelo outro, e com tipos compatíveis. A classe é simples de usar. Por exemplo, suponha que se pretendia fazer um pequeno jogo em que ganha quem gerar um número aleatório maior. Poder-se-ia escrever: #include <IPC/mensageiro.H> // ou #include <IPC/ipc.H> #include <cstdlib> #include <ctime> using namespace IPC; int main() // Se não se fizer isto os jogadores geram sempre o mesmo número // aleatório... srand(time(0)); try // Construir mensageiro: Mensageiro mensageiro; // Escrever identificações: cout << "Eu sou o " << mensageiro.meuidentificador() << endl; cout << "Ele é o " << mensageiro.identificadordooutro() << endl; // Gerar número aleatório: int meu = rand(); // Enviá-lo ao adversário: mensageiro.envia(meu); // Receber número do adeversário: int dele = mensageiro.intrecebido(); // Verificar resultado: if(meu < dele) cout << "Perdi " << meu << " contra " << dele << "..." << endl; else if(meu > dele) cout << "Ganhei " << meu << " contra " << dele <<! << endl; else cout << "Empatámos " << meu << " a " << dele <<. << endl; catch(erro& erro)

17 5.2 Referencia à classe IPC::Mensageiro 13 cerr << string(erro) << endl; Definido na linha 95 do ficheiro mensageiro.h Documentação do Construtor & Destrutor IPC::Mensageiro::Mensageiro (key t const chave = getuid()) Contrutor de um mensageiro. Podem-se criar mensageiros de dois tipos: restritos ou não restritos. O primeiro tipo consegue-se não passando qualquer argumento ao construtor e restringe o emparelhamento dos processos a processos do mesmo utilizador. O segundo tipo é mais geral, pois permite o emparelhamento de processos de utilizadores arbitrários da mesma máquina, mas exige a passagem de uma chave ipc que deve ser única para cada tipo de aplicação prevista. Definido na linha 3 do ficheiro mensageiro.c IPC::Mensageiro:: Mensageiro () Destrutor. Definido na linha 63 do ficheiro mensageiro.c Documentação dos métodos char IPC::Mensageiro::charRecebido () [inline] Devolve um caractere recebido. Definido na linha 19 do ficheiro mensageiro impl.h void IPC::Mensageiro::envia (char const c) [inline] Envia um caractere ao outro. Definido na linha 31 do ficheiro mensageiro impl.h void IPC::Mensageiro::envia (int const valor) [inline] Envia um inteiro ao outro. Definido na linha 27 do ficheiro mensageiro impl.h.

18 14 Pacotes Documentação da classe void IPC::Mensageiro::envia (string const & mensagem) [inline] Envia uma cadeia de caracteres ao outro. Definido na linha 23 do ficheiro mensageiro impl.h. Referenciado por Mensageiro(), e Mensageiro() string IPC::Mensageiro::identificadorDoOutro () [inline] Devolve o identificador único do outro processo, com o qual o corrente está emparelhado através do mensageiro. Definido na linha 6 do ficheiro mensageiro impl.h int IPC::Mensageiro::intRecebido () [inline] Devolve um inteiro recebido do outro. Definido na linha 15 do ficheiro mensageiro impl.h. Referenciado por Mensageiro() string IPC::Mensageiro::meuIdentificador () [inline] Devolve um identificador único para o processo, que consiste no nome do utilizador seguido do número do processo. Definido na linha 1 do ficheiro mensageiro impl.h string IPC::Mensageiro::stringRecebida () [inline] Devolve uma cadeia de caracteres recebida do outro. Definido na linha 11 do ficheiro mensageiro impl.h. Referenciado por Mensageiro(). A documentação para esta classe foi gerada a partir dos seguintes ficheiros: mensageiro.h mensageiro impl.h mensageiro.c

19 Capítulo 6 Pacotes Documentação do ficheiro 6.1 Referencia ao ficheiro erros.h Ficheiro de interface do módulo erros. #include cerrno Namespaces namespace IPC Componentes class IPC::Erro Descrição detalhada Ficheiro de interface do módulo erros. Define a classe IPC::Erro. Definido no ficheiro erros.h.

20 16 Pacotes Documentação do ficheiro 6.2 Referencia ao ficheiro ipc.h Ficheiro de interface da biblioteca. #include IPC/mensageiro.H Namespaces namespace IPC Descrição detalhada Ficheiro de interface da biblioteca. Usa-se se não se pretender discriminar entre os módulos físicos realmente necessários. Definido no ficheiro ipc.h.

21 6.3 Referencia ao ficheiro mensageiro.c Referencia ao ficheiro mensageiro.c #include IPC/mensageiro.H

22 18 Pacotes Documentação do ficheiro 6.4 Referencia ao ficheiro mensageiro.h Ficheiro de interface do módulo mensageiro. #include string #include cstdio #include Extra/string.H #include sys/msg.h #include unistd.h #include pwd.h #include IPC/erros.H #include IPC/mensageiro impl.h Namespaces namespace IPC Componentes class IPC::Mensageiro Definição de macros #define SVID SOURCE Descrição detalhada Ficheiro de interface do módulo mensageiro. Define a classe IPC::Mensageiro. Definido no ficheiro mensageiro.h Documentação da macro #define SVID SOURCE Definido na linha 6 do ficheiro mensageiro.h.

23 6.5 Referencia ao ficheiro mensageiro impl.h Referencia ao ficheiro mensageiro impl.h

24 20 Pacotes Documentação do ficheiro 6.6 Referencia ao ficheiro string.h #include cstdio Funções string& operator+= (string& c, int n) Acrescenta a representação em base decimal de um inteiro a uma cadeia. string operator+ (string c, int n) Devolve a concatenação de uma cadeia com a representação na base decimal de um inteiro. string operator+ (int n, string const& c) Devolve a concatenação da representação na base decimal de um inteiro com uma cadeia Documentação da função string operator+ (int n, string const & c) [inline] Devolve a concatenação da representação na base decimal de um inteiro com uma cadeia. Definido na linha 24 do ficheiro string.h string operator+ (string c, int n) [inline] Devolve a concatenação de uma cadeia com a representação na base decimal de um inteiro. Definido na linha 18 do ficheiro string.h string & operator+= (string & c, int n) [inline] Acrescenta a representação em base decimal de um inteiro a uma cadeia. Definido na linha 10 do ficheiro string.h.

25 Índice Mensageiro IPC::Mensageiro, 13 charrecebido IPC::Mensageiro, 13 envia IPC::Mensageiro, 13 Erro IPC::Erro, 9, 10 identificadordooutro IPC::Mensageiro, 14 intrecebido IPC::Mensageiro, 14 IPC, 7 IPC::Erro, 9 Erro, 9, 10 operator string const, 10 IPC::Mensageiro, 11 Mensageiro, 13 charrecebido, 13 envia, 13 identificadordooutro, 14 intrecebido, 14 Mensageiro, 13 meuidentificador, 14 stringrecebida, 14 Mensageiro IPC::Mensageiro, 13 meuidentificador IPC::Mensageiro, 14 operator string const IPC::Erro, 10 operator+ string.h, 20 operator+= string.h, 20 string.h operator+, 20 operator+=, 20 stringrecebida IPC::Mensageiro, 14