DwmSocket.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmSocket.hh 8618 $
// @(#) $Id: DwmSocket.hh 8618 2016-05-30 04:12:07Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 1998-2007
//  All rights reserved.
//
//  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.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

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

#ifndef _DWMSOCKET_HH_
#define _DWMSOCKET_HH_

extern "C" {
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <netinet/in.h>
}

#include <string>

#include "DwmDescriptor.hh"
#include "DwmIpv4Address.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Socket
    : public Descriptor
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Socket();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Socket(const Socket & sock);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Socket & operator = (const Socket & sock);
    
    operator bool () const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Open(int domain, int type, int protocol);

    int Type() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual Socket Accept(struct sockaddr_in & addr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual Socket Accept(Ipv4Address & addr, uint16_t & port);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Accept(Socket & s, struct sockaddr_in & addr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Accept(Socket & s, Ipv4Address & addr, uint16_t & port);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual Socket Accept(struct sockaddr_un & addr);

    virtual bool Accept(Socket & s, struct sockaddr_un & addr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Listen(int backlog);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Bind(const struct sockaddr_in & addr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Bind(const Ipv4Address & addr, uint16_t port);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Bind(const struct sockaddr_un & addr);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Connect(const struct sockaddr_in & name);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Connect(const Ipv4Address & dstAddr, uint16_t port);
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Connect(const struct sockaddr_un & name);
    
    //------------------------------------------------------------------------
    //  false on failure.
    //------------------------------------------------------------------------
    virtual bool Getpeername(struct sockaddr * name, socklen_t & namelen);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Getpeername(Ipv4Address & addr, uint16_t & port);

    //------------------------------------------------------------------------
    //  false on failure.
    //------------------------------------------------------------------------
    virtual bool Getsockname(struct sockaddr * name, socklen_t & namelen);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Getsockname(Ipv4Address & addr, uint16_t & port);

    //------------------------------------------------------------------------
    //  false on failure.
    //------------------------------------------------------------------------
    virtual bool Setsockopt(int level, int optname, const void * optval,
                            socklen_t optlen);

    //------------------------------------------------------------------------
    //  false on failure.
    //------------------------------------------------------------------------
    virtual bool Getsockopt(int level, int optname, void * optval,
                            socklen_t & optlen);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t RecvFrom(void *buf, size_t len, int flags,
                             struct sockaddr_in & from);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t RecvFrom(void *buf, size_t len, int flags,
                             Ipv4Address & srcAddr, uint16_t & srcPort);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t RecvFrom(std::string & s, int flags,
                             Ipv4Address & srcAddr, uint16_t & srcPort);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t SendTo(const void *buf, size_t len, int flags,
                           const struct sockaddr_in & to);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t SendTo(const void *buf, size_t len, int flags,
                           const Ipv4Address & dstAddr, uint16_t dstPort);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ssize_t SendTo(const std::string & s, int flags,
                           const Ipv4Address & dstAddr, uint16_t dstPort);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool JoinMulticastGroup(const Ipv4Address & groupAddr,
                                    const Ipv4Address & intfAddr);
    
    bool HeaderIncluded() const;
    
  protected:
    int   _type;
    bool  _headerIncluded;
  };
  
}  // namespace Dwm


#endif  // _DWMSOCKET_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------