udpsock.h

Go to the documentation of this file.

/*
 * udpsock.h
 *
 * User Datagram Protocol socket I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 29415 $
 * $Author: rjongbloed $
 * $Date: 2013-04-03 08:41:13 +1100 (Wed, 03 Apr 2013) $
 */

#ifndef PTLIB_UDPSOCKET_H
#define PTLIB_UDPSOCKET_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/ipdsock.h>
 
class PUDPSocket : public PIPDatagramSocket
{
  PCLASSINFO(PUDPSocket, PIPDatagramSocket);

  public:
    PUDPSocket(
      WORD port = 0,             
      int iAddressFamily = AF_INET 
    );
    PUDPSocket(
      const PString & service,   
      int iAddressFamily = AF_INET 
    );
    PUDPSocket(
      const PString & address,  
      WORD port                 
    );
    PUDPSocket(
      const PString & address,  
      const PString & service   
    );

    PBoolean Read(
      void * buf,   
      PINDEX len    
    );

    PBoolean Write(
      const void * buf, 
      PINDEX len        
    );

    PBoolean Connect(
      const PString & address   
    );

    void SetSendAddress(
      const Address & address,    
      WORD port                   
    );
    void SetSendAddress(
      const PIPSocketAddressAndPort & addressAndPort
    );

    void GetSendAddress(
      Address & address,    
      WORD & port           
    ) const;
    void GetSendAddress(
      PIPSocketAddressAndPort & addressAndPort
    ) const;
    PString GetSendAddress() const;

    void GetLastReceiveAddress(
      Address & address,    
      WORD & port           
    ) const;
    void GetLastReceiveAddress(
      PIPSocketAddressAndPort & addressAndPort    
    ) const;
    PString GetLastReceiveAddress() const;

    virtual PBoolean IsAlternateAddress(
      const Address & address,    
      WORD port                    
    );

    virtual PBoolean DoPseudoRead(int & selectStatus);

    // Normally, one would expect these to be protected, but they are just so darn
    // useful that it's just easier if they are public
    virtual void InternalSetSendAddress(const PIPSocketAddressAndPort & addr);
    virtual void InternalGetSendAddress(PIPSocketAddressAndPort & addr) const;
    virtual void InternalSetLastReceiveAddress(const PIPSocketAddressAndPort & addr);
    virtual void InternalGetLastReceiveAddress(PIPSocketAddressAndPort & addr) const;

  protected:
    virtual PBoolean ConvertOSError(P_INT_PTR libcReturnValue, ErrorGroup group = LastGeneralError);

    // Open an IPv4 socket (for backward compatibility)
    virtual PBoolean OpenSocket();

    // Open an IPv4 or IPv6 socket
    virtual PBoolean OpenSocket(
      int ipAdressFamily
    );

    virtual bool InternalListen(const Address & bind, unsigned queueSize, WORD port, Reusability reuse);

    virtual const char * GetProtocolName() const;

// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/udpsock.h"
#else
#include "unix/ptlib/udpsock.h"
#endif

    private:
      Address m_sendAddress;
      WORD    m_sendPort;

      Address m_lastReceiveAddress;
      WORD    m_lastReceivePort;
};


#endif // PTLIB_UDPSOCKET_H


// End Of File ///////////////////////////////////////////////////////////////