SocketHandle.h

Go to the documentation of this file.

//=============================================================================
//  Computational Process Networks class library
//  Copyright (C) 1997-2006  Gregory E. Allen and The University of Texas
//
//  This library is free software; you can redistribute it and/or modify it
//  under the terms of the GNU Library General Public License as published
//  by the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This library 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
//  Library General Public License for more details.
//
//  The GNU Public License is available in the file LICENSE, or you
//  can write to the Free Software Foundation, Inc., 59 Temple Place -
//  Suite 330, Boston, MA 02111-1307, USA, or you can find it on the
//  World Wide Web at http://www.fsf.org.
//=============================================================================
#ifndef SOCKETHANDLE_H
#define SOCKETHANDLE_H
#pragma once
#include <cpn/common.h>
#include <cpn/io/FileHandle.h>
#include <cpn/io/SocketAddress.h>

class SocketHandle : public FileHandle {
public:
    typedef FileHandle::ALock ALock;

    SocketHandle() {}
    SocketHandle(int nfd) : FileHandle(nfd) {}

    static void CreatePair(SocketHandle &sock1, SocketHandle &sock2);
    static void CreatePair(int fd[2]);

    void Connect(const SocketAddress &addr);

    void Connect(const SockAddrList &addrs);

    void ShutdownRead();
    void ShutdownWrite();

    unsigned Recv(void *ptr, unsigned len, bool block);

    struct SendOpts {
        SendOpts() : flags(0) {}
        SendOpts(int f) : flags(f) {}
#if !defined(__APPLE__)
        SendOpts &Block(bool block);
        SendOpts &NoSignal(bool sig);
        SendOpts &More(bool more);
#endif
        int flags;
    };

    unsigned Send(const void *ptr, unsigned len, const SendOpts &opts);

    int GetPendingError();

    void SetKeepAlive(int ka);
    int GetKeepAlive();
    void SetLingerTimeout(int seconds);
    int GetLingerTimeout();

    void SetReceiveBufferSize(int size);
    int GetReceiveBufferSize();
    void SetSendBufferSize(int size);
    int GetSendBufferSize();

    void SetReceiveTimeout(double timeout);
    void SetSendTimeout(double timeout);
    double GetReceiveTimeout();
    double GetSendTimeout();

    void SetNoDelay(bool nodelay);
    bool GetNoDelay();

private:
    bool Connect(const SocketAddress &addr, int &error);
};
#endif