source: xplcommon/src/xplcommon/posix/Socket.h@ 11:9adb0b9c456b

// Copyright (c) 2012 by István Váradi

// This file is part of libxplcommon, a common utility library for
// development related to X-Plane

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:

// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.

#ifndef XPLCOMMON_POSIX_SOCKET_H
#define XPLCOMMON_POSIX_SOCKET_H
//------------------------------------------------------------------------------

#include "BufferedWaitable.h"

//------------------------------------------------------------------------------

struct sockaddr;

//------------------------------------------------------------------------------

namespace xplcommon { namespace posix {

//------------------------------------------------------------------------------

class Connector;

//------------------------------------------------------------------------------

/**
 * A buffered, waitable socket implementation.
 */
class Socket : public BufferedWaitable
{
private:
    /**
     * Construct a socket with the given parameters.
     */
    static int socket(int domain, int type, int protocol);

protected:
    /**
     * Construct the socket with the given parameters.
     */
    Socket(int domain, int type, Waiter* waiter = 0, int protocol = 0,
           size_t readingCapacity = DEFAULT_CAPACITY,
           size_t writingCapacity = DEFAULT_CAPACITY);

    /**
     * Construct the socket with the given file descriptor.
     */
    Socket(int fd, Waiter* waiter = 0,
           size_t readingCapacity = DEFAULT_CAPACITY,
           size_t writingCapacity = DEFAULT_CAPACITY);

public:
    /**
     * Destroy the socket by closing the file descriptor.
     */
    virtual ~Socket();

    friend class ServerSocket;
};

//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------

inline Socket::Socket(int domain, int type, Waiter* waiter, int protocol,
                      size_t readingCapacity, size_t writingCapacity) :
    BufferedWaitable(waiter, socket(domain, type, protocol),
                     readingCapacity, writingCapacity)
{
}

//------------------------------------------------------------------------------

inline Socket::Socket(int fd, Waiter* waiter,
                      size_t readingCapacity, size_t writingCapacity) :
    BufferedWaitable(waiter, fd, readingCapacity, writingCapacity)
{
}

//------------------------------------------------------------------------------

} /* namespace xplcommon::posix */ } /* namespace xplcommon */

//------------------------------------------------------------------------------
#endif // XPLCOMMON_POSIX_SOCKET_H

// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: