Sockets.hpp

Go to the documentation of this file.

#ifndef GOSU_SOCKETS_HPP
#define GOSU_SOCKETS_HPP

#include <boost/cstdint.hpp>
#include <boost/function.hpp>
#include <boost/scoped_ptr.hpp>
#include <cstddef>
#include <string>

namespace Gosu
{
    typedef boost::uint32_t SocketAddress;

    typedef boost::uint16_t SocketPort;
    
    const SocketPort anyPort = 0;
    
    SocketAddress stringToAddress(const std::string& s);
    std::string addressToString(SocketAddress address);

    class MessageSocket
    {
        struct Impl;
        boost::scoped_ptr<Impl> pimpl;

    public:
        explicit MessageSocket(SocketPort port);
        ~MessageSocket();

        SocketAddress address() const;
        SocketPort port() const;
        std::size_t maxMessageSize() const;

        void update();

        void send(SocketAddress address, SocketPort port,
            const void* buffer, std::size_t size);
        /*void broadcast(SocketPort port, const void* buffer,
            std::size_t size);*/

        boost::function<void (SocketAddress, SocketPort, const void*,
            std::size_t)> onReceive;
    };
    
    enum CommMode
    {
        cmRaw,
        //cmLines,
        cmManaged
    };
    
    class Socket;
    
    class CommSocket
    {
        struct Impl;
        boost::scoped_ptr<Impl> pimpl;

    public:
        CommSocket(CommMode mode, SocketAddress targetAddress,
            SocketPort targetPort);
        CommSocket(CommMode mode, Socket& socket);
        ~CommSocket();

        SocketAddress address() const;
        SocketPort port() const;
        SocketAddress remoteAddress() const;
        SocketPort remotePort() const;
        CommMode mode() const;

        bool connected() const;
        void disconnect();
        bool keepAlive() const;
        void setKeepAlive(bool value);

        void update();
        void send(const void* buffer, std::size_t size);
        void sendPendingData();
        std::size_t pendingBytes() const;

        boost::function<void (const void*, std::size_t)> onReceive;
        boost::function<void ()> onDisconnection;
    };
    
    class ListenerSocket
    {
        struct Impl;
        boost::scoped_ptr<Impl> pimpl;

    public:
        ListenerSocket(SocketPort port);
        ~ListenerSocket();

        SocketAddress address() const;
        SocketPort port() const;

        void update();

        boost::function<void (Socket&)> onConnection;
    };
}

#endif

Documentation not clear enough? Please go to one of the places listed on http://www.libgosu.org/ and leave feedback. Thanks!