inet::TCPSocketMap Class Reference

Small utility class for managing a large number of TCPSocket objects. More...

#include <TCPSocketMap.h>

Public Member Functions
	TCPSocketMap ()
	Constructor. More...
	~TCPSocketMap ()
	Destructor. More...
TCPSocket *	findSocketFor (cMessage *msg)
	Finds the socket (by connId) for the given message. More...
void	addSocket (TCPSocket *socket)
	Registers the given socket. More...
TCPSocket *	removeSocket (TCPSocket *socket)
	Removes the given socket from the data structure. More...
unsigned int	size () const
	Returns the number of sockets stored. More...
void	deleteSockets ()
	Deletes the socket objects. More...

Protected Types
typedef std::map< int, TCPSocket * >	SocketMap

Protected Attributes
SocketMap	socketMap

Detailed Description

Small utility class for managing a large number of TCPSocket objects.

Member Typedef Documentation

typedef std::map<int, TCPSocket *> inet::TCPSocketMap::SocketMap

protected

Constructor & Destructor Documentation

inet::TCPSocketMap::TCPSocketMap ( )

inline

Constructor.

{}

inet::TCPSocketMap::~TCPSocketMap ( )

inline

Destructor.

Does NOT delete the TCPSocket objects.

{}

Member Function Documentation

void inet::TCPSocketMap::addSocket

(

TCPSocket *

socket

)

Registers the given socket.

Should not be called multiple times for one socket object.

Referenced by inet::TCPSrvHostApp::handleMessage(), inet::httptools::HttpServer::handleMessage(), inet::bgp::BGPRouting::openTCPConnectionToPeer(), inet::LDP::openTCPConnectionToPeer(), inet::bgp::BGPRouting::processMessageFromTCP(), inet::LDP::processMessageFromTCP(), and inet::httptools::HttpBrowser::submitToSocket().

{
    ASSERT(socketMap.find(socket->getConnectionId()) == socketMap.end());
    socketMap[socket->getConnectionId()] = socket;
}

void inet::TCPSocketMap::deleteSockets

(

)

Deletes the socket objects.

Referenced by inet::httptools::HttpServer::finish(), and inet::httptools::HttpBrowser::~HttpBrowser().

{
    for (auto & elem : socketMap)
        delete elem.second;
    socketMap.clear();
}

TCPSocket * inet::TCPSocketMap::findSocketFor

(

cMessage *

msg

)

Finds the socket (by connId) for the given message.

The message must have arrived from TCP, and must contain a TCPCommand control info object. The method returns nullptr if the socket was not found, and throws an error if the message doesn't contain a TCPCommand.

Referenced by inet::TCPSrvHostApp::handleMessage(), inet::httptools::HttpServer::handleMessage(), inet::httptools::HttpBrowser::handleMessage(), inet::bgp::BGPRouting::processMessageFromTCP(), and inet::LDP::processMessageFromTCP().

{
    TCPCommand *ind = dynamic_cast<TCPCommand *>(msg->getControlInfo());
    if (!ind)
        throw cRuntimeError("TCPSocketMap: findSocketFor(): no TCPCommand control info in message (not from TCP?)");

    int connId = ind->getConnId();
    auto i = socketMap.find(connId);
    ASSERT(i == socketMap.end() || i->first == i->second->getConnectionId());
    return (i == socketMap.end()) ? nullptr : i->second;
}

TCPSocket * inet::TCPSocketMap::removeSocket

(

TCPSocket *

socket

)

Removes the given socket from the data structure.

Referenced by inet::bgp::BGPRouting::listenConnectionFromPeer(), inet::bgp::BGPRouting::openTCPConnectionToPeer(), inet::TCPSrvHostApp::removeThread(), inet::httptools::HttpServer::socketClosed(), inet::httptools::HttpBrowser::socketClosed(), inet::httptools::HttpServer::socketFailure(), and inet::httptools::HttpBrowser::socketFailure().

{
    auto i = socketMap.find(socket->getConnectionId());
    if (i != socketMap.end())
        socketMap.erase(i);
    return socket;
}

unsigned int inet::TCPSocketMap::size ( ) const

inline

Returns the number of sockets stored.

Referenced by inet::TCPSrvHostApp::refreshDisplay().

{ return socketMap.size(); }

Member Data Documentation

SocketMap inet::TCPSocketMap::socketMap

protected

Referenced by addSocket(), deleteSockets(), findSocketFor(), and removeSocket().

---

The documentation for this class was generated from the following files:

• TCPSocketMap.h
• TCPSocketMap.cc