libplumbing/endpoint.h

Go to the documentation of this file.

//
// plumbing - C++ wrapper facades for Berkeley sockets
// Copyright (C) 2009 Peter Miller
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License, version 3, as published
// by the Free Software Foundation.
//
// 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, see <http://www.gnu.org/licenses/>.
//

#ifndef LIBPLUMBING_ENDPOINT_H
#define LIBPLUMBING_ENDPOINT_H

#include <boost/shared_ptr.hpp>

#include <cstdio>
#include <string>
#include <libplumbing/format_printf.h>

namespace plumbing {

class time_value; // forward

class endpoint
{
public:
    typedef boost::shared_ptr<endpoint> pointer;

    virtual ~endpoint();

protected:
    endpoint(int fd);

    endpoint(int fd, const void *sock_addr, int sock_addr_len);

public:
    virtual int get_read_file_descriptor();

    virtual int get_write_file_descriptor();

    virtual void process_read() = 0;

    virtual void process_write() = 0;

    virtual void process_timeout();

    bool is_ready_to_die() const;

    virtual time_value get_maximum_sleep() const;

protected:
    int fd;

    void fatal_error(const char *fmt, ...)
                                                            FORMAT_PRINTF(2, 3);
    static int parse_port_number(const std::string &text);

    static int parse_port_number_or_die(const std::string &text,
        bool empty_is_ok = false);

    void fatal_error_v(const char *fmt, va_list ap)
                                                            FORMAT_PRINTF(2, 0);
    void warning(const char *fmt, ...)
                                                            FORMAT_PRINTF(2, 3);
    void warning_v(const char *fmt, va_list ap)
                                                            FORMAT_PRINTF(2, 0);
    void set_peer_name(const char *name);

    void set_peer_name(const std::string &name);

    const char *get_peer_name() const { return peer_name.c_str(); }

protected:
    virtual void close();

    void kill_me_now();

private:
    std::string peer_name;

    bool ready_to_die;

    void set_peer_name();

    void set_peer_name(const void *sock_addr, int sock_addr_len);

    endpoint();

    endpoint(const endpoint &);

    endpoint &operator=(const endpoint &);
};

}

#endif // LIBPLUMBING_ENDPOINT_H

---