/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2006 Georgia Tech Research Corporation

 *               2007 INRIA

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * Authors: George F. Riley<riley@ece.gatech.edu>

 *          Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#ifndef __SOCKET_H__

#define __SOCKET_H__

#include "ns3/callback.h"

#include "ns3/ptr.h"

#include "ns3/object.h"

#include "address.h"

#include <stdint.h>

namespace ns3 {

class Node;

class Packet;

/**

 * \brief Define a Socket API based on the BSD Socket API.

 *

 * Contrary to the original BSD socket API, this API is asynchronous:

 */

class Socket : public Object

{

public:

  virtual ~Socket();

  enum SocketErrno {

    ERROR_NOTERROR,

    ERROR_ISCONN,

    ERROR_NOTCONN,

    ERROR_MSGSIZE,

    ERROR_AGAIN,

    ERROR_SHUTDOWN,

    ERROR_OPNOTSUPP,

    ERROR_AFNOSUPPORT,

    ERROR_INVAL,

    ERROR_BADF,

    ERROR_NOROUTETOHOST,

    SOCKET_ERRNO_LAST

  };

  /**

   * \return the errno associated to the last call which failed in this

   *         socket. Each socket's errno is initialized to zero

   *         when the socket is created.

   */

  virtual enum Socket::SocketErrno GetErrno (void) const = 0;

  /**

   * \returns the node this socket is associated with.

   */

  virtual Ptr<Node> GetNode (void) const = 0;

  /**

   * \param closeCompleted Callback invoked when the close operation is

   *        completed.

   */

  void SetCloseCallback (Callback<void, Ptr<Socket> > closeCompleted);

  /**

   * \param connectionSucceeded this callback is invoked when the 

   *        connection request initiated by the user is successfully 

   *        completed. The callback is passed  back a pointer to 

   *        the same socket object.

   * \param connectionFailed this callback is invoked when the 

   *        connection request initiated by the user is unsuccessfully 

   *        completed. The callback is passed back a pointer to the 

   *        same socket object. 

   * \param halfClose XXX When exactly is this callback invoked? If 

   *        it invoked when the other side closes the connection ? 

   *        Or when I call Close ?

   */

  void SetConnectCallback (Callback<void, Ptr<Socket> > connectionSucceeded,

  /**

   * \brief Accept connection requests from remote hosts

   * \param connectionRequest Callback for connection request from peer. 

   *        This user callback is passed a pointer to this socket, the 

   *        ip address and the port number of the connection originator. 

   *        This callback must return true to accept the incoming connection,

   *        false otherwise. If the connection is accepted, the 

   *        "newConnectionCreated" callback will be invoked later to 

   *        give access to the user to the socket created to match 

   *        this new connection. If the user does not explicitly 

   *        specify this callback, all incoming  connections will be refused.

   * \param newConnectionCreated Callback for new connection: when a new

   *        is accepted, it is created and the corresponding socket is passed

   *        back to the user through this callback. This user callback is 

   *        passed a pointer to the new socket, and the ip address and 

   *        port number of the connection originator.

   * \param closeRequested Callback for connection close request from peer.

   *        XXX: when is this callback invoked ?

   */

  void SetAcceptCallback (Callback<bool, Ptr<Socket>, 

                            const Address &> connectionRequest,

                          Callback<void, Ptr<Socket>, 

                            const Address&> newConnectionCreated,

                          Callback<void, Ptr<Socket> > closeRequested);

  /**

   * \brief Notify application when a packet has been sent from transport 

   *        protocol (non-standard socket call)

   * \param dataSent Callback for the event that data is sent from the

   *        underlying transport protocol.  This callback is passed a

   *        pointer to the socket, and the number of bytes sent.

   * \returns whether or not this socket supports this callback.  Note 

   *        that this is a non-standard socket call.  Some socket 

   *        implementations in ns-3 may not support this call, so the

   *        user should check this return value to confirm that the

   *        callback is supported.

   */

  virtual bool SetDataSentCallback (Callback<void, Ptr<Socket>, uint32_t> dataSent);

  /**

   * \brief Notify application when space in transmit buffer is added

   *

   *        This callback is intended to notify a 

   *        socket that would have been blocked in a blocking socket model

   *

   * \param sendCb Callback for the event that the socket transmit buffer

   *        fill level has decreased.  This callback is passed a pointer to

   *        the socket, and the number of bytes available for writing

   *        into the buffer (an absolute value).  If there is no transmit

   *        buffer limit, a maximum-sized integer is always returned.

   */

  void SetSendCallback (Callback<void, Ptr<Socket>, uint32_t> sendCb);

  /**

   * \brief Receive data

   * \param receivedData Invoked whenever new data is received.

   *

   */

  void SetRecvCallback (Callback<void, Ptr<Socket>, Ptr<Packet>,

                          const Address&> receivedData);

  /** 

   * \param address the address to try to allocate

   * \returns 0 on success, -1 on failure.

   *

   * Allocate a local endpoint for this socket.

   */

  virtual int Bind (const Address &address) = 0;

  /** 

   * Allocate a local endpoint for this socket.

   *

   * \returns 0 on success, -1 on failure.

   */

  virtual int Bind () = 0;

  /** 

   * \brief Close a socket.

   *

   * After the Close call, the socket is no longer valid, and cannot

   * safely be used for subsequent operations.

   */

  /**

   * \returns zero on success, -1 on failure.

   *

   * Do not allow any further Send calls. This method is typically

   * implemented for Tcp sockets by a half close.

   */

  virtual int ShutdownSend (void) = 0;

  /**

   * \returns zero on success, -1 on failure.

   *

   * Do not allow any further Recv calls. This method is typically

   * implemented for Tcp sockets by a half close.

   */

  virtual int ShutdownRecv (void) = 0;

  /**

   * \brief Initiate a connection to a remote host

   * \param address Address of remote.

   */

  /**

   * \brief Send data (or dummy data) to the remote host

   * \param p packet to send

   * \returns -1 in case of error or the number of bytes copied in the 

   *          internal buffer and accepted for transmission.

   */

  virtual int Send (Ptr<Packet> p) = 0;

  /**

   * \brief Send data (or dummy data) to the remote host

   * \param buf A pointer to a raw byte buffer of some data to send.  If this 

   * is 0, we send dummy data whose size is specified by the second parameter

   * \param size the number of bytes to copy from the buffer

   * 

   * This is provided so as to have an API which is closer in appearance 

   * to that of real network or BSD sockets.  

   */

  int Send (const uint8_t* buf, uint32_t size);

  /**

   * \brief Send data to a specified peer.

   * \param address IP Address of remote host

   * \param p packet to send

   * \returns -1 in case of error or the number of bytes copied in the 

   *          internal buffer and accepted for transmission.

   */

  /**

   * \brief Send data to a specified peer.

   * \param address IP Address of remote host

   * \param buf A pointer to a raw byte buffer of some data to send.  If this 

   * is 0, we send dummy data whose size is specified by the third parameter

   * \param size the number of bytes to copy from the buffer

   * \returns -1 in case of error or the number of bytes copied in the 

   *          internal buffer and accepted for transmission.

   *

   * This is provided so as to have an API which is closer in appearance 

   * to that of real network or BSD sockets.

   */

protected:

  void NotifyCloseCompleted (void);

  void NotifyConnectionSucceeded (void);

  void NotifyConnectionFailed (void);

  void NotifyHalfClose (void);

  bool NotifyConnectionRequest (const Address &from);

  void NotifyNewConnectionCreated (Ptr<Socket> socket, const Address &from);

  void NotifyCloseRequested (void);

  void NotifyDataSent (uint32_t size);

  void NotifySend (uint32_t spaceAvailable);

  void NotifyDataReceived (Ptr<Packet> p, const Address &from);

  Callback<void,Ptr<Socket> >    m_closeCompleted;

  Callback<void, Ptr<Socket> >   m_connectionSucceeded;

  Callback<void, Ptr<Socket> >   m_connectionFailed;

  Callback<void, Ptr<Socket> >   m_halfClose;

  Callback<void, Ptr<Socket> >   m_closeRequested;

  Callback<bool, Ptr<Socket>, const Address &>   m_connectionRequest;

  Callback<void, Ptr<Socket>, const Address&>    m_newConnectionCreated;

  Callback<void, Ptr<Socket>, uint32_t>          m_dataSent;

  Callback<void, Ptr<Socket>, uint32_t >         m_sendCb;

  Callback<void, Ptr<Socket>, Ptr<Packet>,const Address&> m_receivedData;

};

} //namespace ns3

#endif /* SOCKET_H */