tcpip::Socket Class Reference

#include <socket.h>

Collaboration diagram for tcpip::Socket:

Public Member Functions
void	accept () throw ( SocketException )
	Wait for a incoming connection to port_. More...
void	close ()
void	connect () throw ( SocketException )
	Connects to host_:port_. More...
bool	has_client_connection () const
bool	is_blocking () throw ()
int	port ()
std::vector< unsigned char >	receive (int bufSize=2048) throw ( SocketException )
	Receive up to bufSize available bytes from Socket::socket_. More...
bool	receiveExact (Storage &) throw ( SocketException )
	Receive a complete TraCI message from Socket::socket_. More...
void	send (const std::vector< unsigned char > &buffer) throw ( SocketException )
void	sendExact (const Storage &) throw ( SocketException )
void	set_blocking (bool) throw ( SocketException )
void	set_verbose (bool newVerbose)
	Socket (std::string host, int port)
	Constructor that prepare to connect to host:port. More...
	Socket (int port)
	Constructor that prepare for accepting a connection on given port. More...
bool	verbose ()
	~Socket ()
	Destructor. More...

Protected Member Functions
void	printBufferOnVerbose (const std::vector< unsigned char > buffer, const std::string &label) const
	Print label and buffer to stderr if Socket::verbose_ is set. More...
void	receiveComplete (unsigned char *const buffer, std::size_t len) const
	Receive len bytes from Socket::socket_. More...
size_t	recvAndCheck (unsigned char *const buffer, std::size_t len) const
	Receive up to len available bytes from Socket::socket_. More...

Static Protected Attributes
static const int	lengthLen = 4
	Length of the message length part of a TraCI message. More...

Private Member Functions
bool	atoaddr (std::string, struct in_addr &addr)
void	BailOnSocketError (std::string) const throw ( SocketException )
bool	datawaiting (int sock) const throw ()
void	init ()

Private Attributes
bool	blocking_
std::string	host_
int	port_
int	server_socket_
int	socket_
bool	verbose_

Friends
class	Response

Detailed Description

Definition at line 78 of file socket.h.

Constructor & Destructor Documentation

tcpip::Socket::Socket	(	std::string	host,
		int	port
	)

Constructor that prepare to connect to host:port.

Definition at line 72 of file socket.cpp.

References init().

tcpip::Socket::Socket

(

int

port

)

Constructor that prepare for accepting a connection on given port.

Definition at line 85 of file socket.cpp.

References init().

tcpip::Socket::~Socket

(

)

Destructor.

Definition at line 116 of file socket.cpp.

References close(), server_socket_, and socket_.

Member Function Documentation

void tcpip::Socket::accept	(		)
throw	(	SocketException
	)

Wait for a incoming connection to port_.

Definition at line 221 of file socket.cpp.

References BailOnSocketError(), blocking_, port_, server_socket_, set_blocking(), and socket_.

Referenced by TraCIServer::TraCIServer().

bool tcpip::Socket::atoaddr ( std::string  address, struct in_addr &  addr  )

private

Definition at line 195 of file socket.cpp.

Referenced by connect().

void tcpip::Socket::BailOnSocketError ( std::string  context ) const throw ( SocketException )

private

Definition at line 146 of file socket.cpp.

Referenced by accept(), connect(), init(), and recvAndCheck().

void tcpip::Socket::close

(

)

Definition at line 345 of file socket.cpp.

References socket_.

Referenced by TraCIAPI::close(), OutputDevice_Network::~OutputDevice_Network(), ~Socket(), and TraCIServer::~TraCIServer().

void tcpip::Socket::connect	(		)
throw	(	SocketException
	)

Connects to host_:port_.

Definition at line 314 of file socket.cpp.

References atoaddr(), BailOnSocketError(), host_, port_, and socket_.

Referenced by TraCIAPI::connect(), and OutputDevice_Network::OutputDevice_Network().

bool tcpip::Socket::datawaiting ( int  sock ) const throw ( )

private

Definition at line 170 of file socket.cpp.

bool tcpip::Socket::has_client_connection

(

)

const

Definition at line 526 of file socket.cpp.

References socket_.

void tcpip::Socket::init ( )

private

Definition at line 99 of file socket.cpp.

References BailOnSocketError().

Referenced by Socket().

bool tcpip::Socket::is_blocking	(		)
throw	(
	)

Definition at line 535 of file socket.cpp.

References blocking_.

int tcpip::Socket::port

(

)

Definition at line 161 of file socket.cpp.

References port_.

void tcpip::Socket::printBufferOnVerbose ( const std::vector< unsigned char >  buffer, const std::string &  label  ) const

protected

Print label and buffer to stderr if Socket::verbose_ is set.

Definition at line 449 of file socket.cpp.

References verbose_.

std::vector< unsigned char > tcpip::Socket::receive	(	int	bufSize = 2048	)
throw	(	SocketException
	)

Receive up to bufSize available bytes from Socket::socket_.

Definition at line 467 of file socket.cpp.

void tcpip::Socket::receiveComplete ( unsigned char *const  buffer, std::size_t  len  ) const

protected

Receive len bytes from Socket::socket_.

Definition at line 434 of file socket.cpp.

References recvAndCheck().

bool tcpip::Socket::receiveExact	(	Storage &	msg	)
throw	(	SocketException
	)

Receive a complete TraCI message from Socket::socket_.

Definition at line 493 of file socket.cpp.

References tcpip::Storage::readInt().

Referenced by TraCIAPI::check_resultState(), and TraCIServer::processCommandsUntilSimStep().

size_t tcpip::Socket::recvAndCheck ( unsigned char *const  buffer, std::size_t  len  ) const

protected

Receive up to len available bytes from Socket::socket_.

Definition at line 414 of file socket.cpp.

References BailOnSocketError(), and socket_.

Referenced by receiveComplete().

void tcpip::Socket::send	(	const std::vector< unsigned char > &	buffer	)
throw	(	SocketException
	)

Definition at line 363 of file socket.cpp.

Referenced by OutputDevice_Network::postWriteHook().

void tcpip::Socket::sendExact	(	const Storage &	b	)
throw	(	SocketException
	)

Definition at line 394 of file socket.cpp.

References tcpip::Storage::begin(), tcpip::Storage::end(), and tcpip::Storage::writeInt().

Referenced by TraCIServer::close(), TraCIServer::processCommandsUntilSimStep(), TraCIAPI::send_commandClose(), TraCIAPI::send_commandGetVariable(), TraCIAPI::send_commandSetValue(), TraCIAPI::send_commandSimulationStep(), TraCIAPI::send_commandSubscribeObjectContext(), and TraCIAPI::send_commandSubscribeObjectVariable().

void tcpip::Socket::set_blocking	(	bool	blocking	)
throw	(	SocketException
	)

Definition at line 286 of file socket.cpp.

Referenced by accept().

void tcpip::Socket::set_verbose ( bool  newVerbose )

inline

Definition at line 111 of file socket.h.

References verbose_.

bool tcpip::Socket::verbose ( )

inline

Definition at line 110 of file socket.h.

References verbose_.

Friends And Related Function Documentation

friend class Response

friend

Definition at line 80 of file socket.h.

Field Documentation

bool tcpip::Socket::blocking_

private

Definition at line 137 of file socket.h.

Referenced by accept(), and is_blocking().

std::string tcpip::Socket::host_

private

Definition at line 133 of file socket.h.

Referenced by connect().

const int tcpip::Socket::lengthLen = 4

staticprotected

Length of the message length part of a TraCI message.

Definition at line 115 of file socket.h.

int tcpip::Socket::port_

private

Definition at line 134 of file socket.h.

Referenced by accept(), connect(), and port().

int tcpip::Socket::server_socket_

private

Definition at line 136 of file socket.h.

Referenced by accept(), and ~Socket().

int tcpip::Socket::socket_

private

Definition at line 135 of file socket.h.

Referenced by accept(), close(), connect(), has_client_connection(), recvAndCheck(), and ~Socket().

bool tcpip::Socket::verbose_

private

Definition at line 139 of file socket.h.

Referenced by printBufferOnVerbose(), set_verbose(), and verbose().

---

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

• socket.h
• socket.cpp