UDPSocket.h

Go to the documentation of this file.

//
// Copyright (C) 2005 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.
//


#ifndef __INET_UDPSOCKET_H
#define __INET_UDPSOCKET_H

#include <omnetpp.h>
#include "UDPControlInfo_m.h"


class INET_API UDPSocket
{
  public:
    class CallbackInterface
    {
      public:
        virtual ~CallbackInterface() {}
        virtual void socketDatagramArrived(int sockId, void *yourPtr, cMessage *msg, UDPControlInfo *ctrl) = 0;
        virtual void socketPeerClosed(int sockId, void *yourPtr) {}
    };

    enum State {NOT_BOUND, BOUND};  // FIXME needed?

  protected:
    int sockId;
    int usrId;
    int sockstate;

    IPvXAddress localAddr; // needed for sendTo() as local address
    int localPrt;
    IPvXAddress remoteAddr; // needed to enable send(msg) call
    int remotePrt; // needed to enable send(msg) call
    int mcastIfaceId;

    CallbackInterface *cb;
    void *yourPtr;

    cGate *gateToUdp;

  protected:
    void sendToUDP(cMessage *msg);

  public:
    UDPSocket();

    ~UDPSocket() {}

    int getSocketId() const  {return sockId;}

    void setUserId(int userId);

    int getUserId() const  {return usrId;}

    int getState()   {return sockstate;}

    static const char *stateName(int state);

    static int generateSocketId();

    IPvXAddress getLocalAddress() {return localAddr;}
    int getLocalPort() {return localPrt;}


    void setOutputGate(cGate *toUdp)  {gateToUdp = toUdp;}

    void bind(int localPort);

    void bind(IPvXAddress localAddr, int localPort);

    void connect(IPvXAddress remoteAddr, int remotePort);

    void setMulticastInterfaceId(int interfaceId) {mcastIfaceId = interfaceId;}

    int getMulticastInterfaceId() const {return mcastIfaceId;}

    void sendTo(cMessage *msg, IPvXAddress destAddr, int destPort);

    void send(cMessage *msg);

    void close();

    bool belongsToSocket(cMessage *msg);

    static bool belongsToAnyUDPSocket(cMessage *msg);

    void setCallbackObject(CallbackInterface *cb, void *yourPtr=NULL);

    void processMessage(cMessage *msg);
};

#endif