Siena C++ API documentation (v. 0.4.3)

---

Comm.h

// -*- C++ -*-
//
//  This file is part of Siena, a wide-area event notification system.
//  See http://www.cs.colorado.edu/serl/siena/
//
//  Author: Antonio Carzaniga <[email protected]>
//  See the file AUTHORS for full details. 
//
//  Copyright (C) 1998-2001 University of Colorado
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307,
//  USA, or send email to [email protected].
//
//
// $Id: Comm.h,v 1.1 2003/07/09 20:17:31 carzanig Exp $
//
#ifndef _Comm_h
#define _Comm_h

#include <sienaconf.h>

#ifdef USING_WIN32
#include <winsock.h>
#else
#include<sys/socket.h>
#include<netinet/in.h>
#endif

#include <exception>
#include <string>

using namespace std;

#ifdef HAVE_CXX_NAMESPACE
namespace Siena {
#endif

class CommException: public exception {
public:
    virtual const char *what() const throw ();
};

class CommError: public CommException {
public:
    virtual const char *what() const throw ();
};

class CommInterrupted: public CommException {
public:
    virtual const char *what() const throw ();
};

class BadSender: public exception {
public:
    virtual const char *what() const throw ();
};

class BadSenderSchema: public BadSender {
public:
    virtual const char *what() const throw ();
};

class UnknownHost: public BadSender {
public:
    virtual const char *what() const throw ();
};

class Sender { 
 public:
    static Sender *     create_sender(const string &);

    virtual             ~Sender();

    virtual void        send(const char *, size_t) throw (CommException) = 0;

    virtual void        shutdown();
};

class Receiver { 
 public:
    virtual             ~Receiver();

    virtual string      uri() = 0;

    virtual string &    uri(string &) = 0;

    virtual size_t      receive(char *, size_t) throw (CommException) = 0;

    virtual void        shutdown();
};

class TCPSender: public Sender {
public:
                        TCPSender(const string &host, in_port_t port);
                        TCPSender(in_addr_t ip, in_port_t port);

    virtual void        send(const char *, size_t) throw (CommException);

private:
    in_port_t port;
    in_addr_t ip;
};

class UDPSender: public Sender {
public:
                        UDPSender(const string &host, in_port_t port);
                        UDPSender(in_addr_t ip, in_port_t port);

    virtual void        shutdown();

    virtual void        send(const char *, size_t) throw (CommException);
private:
    in_port_t port;
    in_addr_t ip;
#ifdef USING_WIN32
    SOCKET sock_fd;
#else
    int sock_fd;
#endif
};

class TCPReceiver: public Receiver {
public:
                        TCPReceiver(in_port_t port, 
                                    const char * hostname = NULL, 
                                    bool reuse = true, 
                                    int maxconn = -1 /* default */);

    virtual size_t      receive(char *, size_t) throw (CommException);
    virtual void        shutdown();

    virtual string      uri();
    virtual string &    uri(string &);

private:
    in_port_t port;
    string _uri;
#ifdef USING_WIN32
    SOCKET sock_fd;
#else
    int sock_fd;
#endif
};


class UDPReceiver: public Receiver {
public:
                        UDPReceiver(in_port_t port, 
                                    const char * hostname = NULL, 
                                    bool reuse = true);

    virtual size_t      receive(char *, size_t) throw (CommException);
    virtual void        shutdown();

    virtual string      uri();
    virtual string &    uri(string &);

private:
    in_port_t port;
    string _uri;
#ifdef USING_WIN32
    SOCKET sock_fd;
#else
    int sock_fd;
#endif
};

#ifndef NO_INLINE
#include <siena/Comm.icc>
#endif

#ifdef HAVE_CXX_NAMESPACE
}; // namespace Siena
#endif

#endif

---

Copyright © 2001 University of Colorado.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". This documentation is authored and maintained by Antonio Carzaniga