TraCI server used to control sumo by a remote TraCI client. More...

#include <TraCIServer.h>

Inheritance diagram for TraCIServer:

Collaboration diagram for TraCIServer:

Data Structures
struct	SocketInfo

class	Subscription
	Representation of a subscription. More...

Public Types
typedef bool(*	CmdExecutor) (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
	Definition of a method to be called for serving an associated commandID. More...

Public Member Functions
void	cleanup ()
	clean up subscriptions More...

void	collectObjectsInRange (int domain, const PositionVector &shape, double range, std::set< std::string > &into)

SUMOTime	getTargetTime () const

const std::map< MSNet::VehicleState, std::vector< std::string > > &	getVehicleStateChanges () const

bool	isEmbedded () const

void	postProcessVTD ()

void	processCommandsUntilSimStep (SUMOTime step)
	process all commands until the next SUMO simulation step. It is guaranteed that t->getTargetTime() >= myStep after call (except the case that a load or close command is received)s More...

void	setVTDControlled (MSVehicle v, Position xyPos, MSLane l, double pos, double posLat, double angle, int edgeOffset, ConstMSEdgeVector route, SUMOTime t)

void	vehicleStateChanged (const SUMOVehicle *const vehicle, MSNet::VehicleState to)
	Called if a vehicle changes its state. More...

void	writeResponseWithLength (tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)

Writing Status Messages
void	writeStatusCmd (int commandId, int status, const std::string &description, tcpip::Storage &outputStorage)
	Writes a status command to the given storage. More...

void	writeStatusCmd (int commandId, int status, const std::string &description)
	Writes a status command to myOutputStorage. More...

bool	writeErrorStatusCmd (int commandId, const std::string &description, tcpip::Storage &outputStorage)
	Writes a status command to the given storage with status = RTYPE_ERR. More...

Helpers for reading and checking values
bool	readTypeCheckingInt (tcpip::Storage &inputStorage, int &into)
	Reads the value type and an int, verifying the type. More...

bool	readTypeCheckingDouble (tcpip::Storage &inputStorage, double &into)
	Reads the value type and a double, verifying the type. More...

bool	readTypeCheckingString (tcpip::Storage &inputStorage, std::string &into)
	Reads the value type and a string, verifying the type. More...

bool	readTypeCheckingStringList (tcpip::Storage &inputStorage, std::vector< std::string > &into)
	Reads the value type and a string list, verifying the type. More...

bool	readTypeCheckingColor (tcpip::Storage &inputStorage, TraCIColor &into)
	Reads the value type and a color, verifying the type. More...

bool	readTypeCheckingPosition2D (tcpip::Storage &inputStorage, TraCIPosition &into)
	Reads the value type and a 2D position, verifying the type. More...

bool	readTypeCheckingBoundary (tcpip::Storage &inputStorage, Boundary &into)
	Reads the value type and a 2D bounding box, verifying the type. More...

bool	readTypeCheckingByte (tcpip::Storage &inputStorage, int &into)
	Reads the value type and a byte, verifying the type. More...

bool	readTypeCheckingUnsignedByte (tcpip::Storage &inputStorage, int &into)
	Reads the value type and an unsigned byte, verifying the type. More...

bool	readTypeCheckingPolygon (tcpip::Storage &inputStorage, PositionVector &into)
	Reads the value type and a polygon, verifying the type. More...

Static Public Member Functions
static TraCIServer *	getInstance ()

Initialisation and Shutdown
static void	openSocket (const std::map< int, CmdExecutor > &execs)
	Initialises the server. More...

static void	close ()
	request termination of connection More...

static bool	wasClosed ()
	check whether close was requested More...

Private Member Functions
bool	addObjectVariableSubscription (const int commandId, const bool hasContext)

void	checkClientOrdering ()
	Called once after connection of all clients for executing SET_ORDER (and possibly prior GET_VERSION) commands, that should be executed before simulation starts (in processCommandsUntilNextSimStep()). More...

int	dispatchCommand ()
	Handles command, writes response to myOutputStorage. More...

bool	findObjectShape (int domain, const std::string &id, PositionVector &shape)

void	initialiseSubscription (const Subscription &s)

SUMOTime	nextTargetTime () const
	get the minimal next target time among all clients More...

TraCIServer &	operator= (const TraCIServer &s)
	Invalidated assignment operator. More...

void	processReorderingRequests ()
	checks for and processes reordering requests (relevant for multiple clients) More...

bool	processSingleSubscription (const TraCIServer::Subscription &s, tcpip::Storage &writeInto, std::string &errors)

int	readCommandID (int &commandStart, int &commandLength)
	Reads the next command ID from the input storage. More...

std::map< int, SocketInfo * >::iterator	removeCurrentSocket ()
	removes myCurrentSocket from mySockets and returns an iterator pointing to the next member according to the ordering More...

void	removeSubscription (int commandId, const std::string &identity, int domain)

void	sendOutputToAll () const
	send out subscription results (actually just the content of myOutputStorage) to clients which will act in this step (i.e. with client target time <= myTargetTime) More...

void	sendSingleSimStepResponse ()
	sends an empty response to a simstep command to the current client. (This applies to a situation where the TraCI step frequency is higher than the SUMO step frequency) More...

	TraCIServer (const SUMOTime begin, const int port, const int numClients)
	Constructor. More...

virtual	~TraCIServer ()
	Destructor. More...

Server-internal command handling
bool	commandGetVersion ()
	Returns the TraCI-version. More...

void	postProcessSimulationStep ()
	Handles subscriptions to send after a simstep2 command. More...

Private Attributes
const bool	myAmEmbedded
	Whether the server runs in embedded mode. More...

std::map< int, SocketInfo * >::iterator	myCurrentSocket
	The currently active client socket. More...

std::map< int, CmdExecutor >	myExecutors
	Map of commandIds -> their executors; applicable if the executor applies to the method footprint. More...

tcpip::Storage	myInputStorage
	The storage to read from. More...

LANE_RTREE_QUAL *	myLaneTree
	A storage of lanes. More...

std::map< int, NamedRTree * >	myObjects
	A storage of objects. More...

tcpip::Storage	myOutputStorage
	The storage to writeto. More...

std::map< int, int >	myParameterSizes
	Map of variable ids to the size of the parameter in bytes. More...

tcpip::Socket *	myServerSocket
	The server socket. More...

std::map< int, SocketInfo * >	mySocketReorderRequests
	This stores the setOrder(int) requests of the clients. More...

std::map< int, SocketInfo * >	mySockets
	The socket connections to the clients the first component (index) determines the client's order (lowest index's commands are processed first),. More...

tcpip::Storage	mySubscriptionCache
	The last timestep's subscription results. More...

std::vector< Subscription >	mySubscriptions
	The list of known, still valid subscriptions. More...

SUMOTime	myTargetTime
	The time step to reach until processing the next commands. More...

std::map< MSNet::VehicleState, std::vector< std::string > >	myVehicleStateChanges
	Changes in the states of simulated vehicles. More...

std::map< std::string, MSVehicle * >	myVTDControlledVehicles

Static Private Attributes
static bool	myDoCloseConnection = false
	Whether the connection was set to be to close. More...

static TraCIServer *	myInstance = 0
	Singleton instance of the server. More...

Detailed Description

TraCI server used to control sumo by a remote TraCI client.

Definition at line 74 of file TraCIServer.h.

Member Typedef Documentation

typedef bool(* TraCIServer::CmdExecutor) (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)

Definition of a method to be called for serving an associated commandID.

Definition at line 77 of file TraCIServer.h.

Constructor & Destructor Documentation

TraCIServer::TraCIServer	(	const SUMOTime	begin,
		const int	port,
		const int	numClients
	)

private

Constructor.

Parameters

[in] port The port to listen to (to open)

Definition at line 112 of file TraCIServer.cpp.

Referenced by getVehicleStateChanges(), and openSocket().

TraCIServer::~TraCIServer ( )

privatevirtual

Destructor.

Definition at line 199 of file TraCIServer.cpp.

References cleanup(), myCurrentSocket, myServerSocket, and mySockets.

Referenced by getVehicleStateChanges().

Member Function Documentation

bool TraCIServer::addObjectVariableSubscription	(	const int	commandId,
		const bool	hasContext
	)

private

Definition at line 1313 of file TraCIServer.cpp.

References initialiseSubscription(), myInputStorage, myParameterSizes, tcpip::Storage::readChar(), tcpip::Storage::readDouble(), tcpip::Storage::readInt(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), and removeSubscription().

Referenced by dispatchCommand().

void TraCIServer::checkClientOrdering ( )

private

Called once after connection of all clients for executing SET_ORDER (and possibly prior GET_VERSION) commands, that should be executed before simulation starts (in processCommandsUntilNextSimStep()).

Definition at line 284 of file TraCIServer.cpp.

References CMD_GETVERSION, CMD_SETORDER, dispatchCommand(), myCurrentSocket, myInputStorage, myOutputStorage, mySockets, readCommandID(), tcpip::Storage::reset(), tcpip::Storage::writeStorage(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCIServer().

void TraCIServer::cleanup ( )

clean up subscriptions

Definition at line 598 of file TraCIServer.cpp.

References tcpip::Storage::begin(), dispatchCommand(), tcpip::Storage::end(), FileHelpers::getFilePath(), OptionsCont::getOptions(), myCurrentSocket, myInputStorage, myInstance, myLaneTree, myObjects, myOutputStorage, mySockets, mySubscriptionCache, mySubscriptions, myTargetTime, myVehicleStateChanges, tcpip::Storage::reset(), string2time(), tcpip::SocketException::what(), and tcpip::Storage::writeChar().

Referenced by MSNet::clearAll(), getInstance(), and ~TraCIServer().

void TraCIServer::close ( )

static

request termination of connection

Definition at line 231 of file TraCIServer.cpp.

References myDoCloseConnection, and myInstance.

Referenced by getInstance(), and main().

void TraCIServer::collectObjectsInRange	(	int	domain,
		const PositionVector &	shape,
		double	range,
		std::set< std::string > &	into
	)

bool TraCIServer::commandGetVersion ( )

private

Returns the TraCI-version.

Returns: Always true

Definition at line 896 of file TraCIServer.cpp.

References CMD_GETVERSION, myOutputStorage, RTYPE_OK, tcpip::Storage::size(), TRACI_VERSION, VERSION_STRING, tcpip::Storage::writeInt(), writeStatusCmd(), tcpip::Storage::writeStorage(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by dispatchCommand().

int TraCIServer::dispatchCommand ( )

private

Handles command, writes response to myOutputStorage.

Definition at line 744 of file TraCIServer.cpp.

Referenced by checkClientOrdering(), cleanup(), and processCommandsUntilSimStep().

bool TraCIServer::findObjectShape	(	int	domain,
		const std::string &	id,
		PositionVector &	shape
	)

private

static TraCIServer* TraCIServer::getInstance ( void )

inlinestatic

Definition at line 86 of file TraCIServer.h.

References cleanup(), close(), myInstance, openSocket(), postProcessVTD(), processCommandsUntilSimStep(), setVTDControlled(), vehicleStateChanged(), wasClosed(), writeErrorStatusCmd(), and writeStatusCmd().

Referenced by MSNet::clearAll(), GUIRunThread::makeStep(), MSNet::postSimStepOutput(), MSNet::simulate(), MSNet::simulationState(), and MSNet::simulationStep().

SUMOTime TraCIServer::getTargetTime ( ) const

inline

Definition at line 80 of file TraCIServer.h.

References myTargetTime.

Referenced by MSNet::simulationStep().

const std::map<MSNet::VehicleState, std::vector<std::string> >& TraCIServer::getVehicleStateChanges ( ) const

inline

void TraCIServer::initialiseSubscription ( const Subscription & s )

private

Definition at line 1022 of file TraCIServer.cpp.

Referenced by addObjectVariableSubscription().

bool TraCIServer::isEmbedded ( ) const

inline

Definition at line 83 of file TraCIServer.h.

References myAmEmbedded.

Referenced by MSNet::simulationStep().

SUMOTime TraCIServer::nextTargetTime ( ) const

private

get the minimal next target time among all clients

Definition at line 393 of file TraCIServer.cpp.

References max, MIN2(), and mySockets.

Referenced by processCommandsUntilSimStep().

void TraCIServer::openSocket ( const std::map< int, CmdExecutor > & execs )

static

Initialises the server.

Parameters

[in] execs The (additional) command executors to use

Definition at line 210 of file TraCIServer.cpp.

References MSNet::addVehicleStateListener(), MSNet::getInstance(), OptionsCont::getOptions(), myDoCloseConnection, myExecutors, myInstance, string2time(), and TraCIServer().

Referenced by getInstance(), NLBuilder::loadAndRun(), and GUILoadThread::run().

TraCIServer& TraCIServer::operator= ( const TraCIServer & s )

private

Invalidated assignment operator.

void TraCIServer::postProcessSimulationStep ( )

private

Handles subscriptions to send after a simstep2 command.

Definition at line 915 of file TraCIServer.cpp.

References TraCIServer::Subscription::beginTime, CMD_SIMSTEP, CMD_SUBSCRIBE_PERSON_CONTEXT, CMD_SUBSCRIBE_PERSON_VARIABLE, CMD_SUBSCRIBE_VEHICLE_CONTEXT, CMD_SUBSCRIBE_VEHICLE_VARIABLE, TraCIServer::Subscription::commandId, TraCIServer::Subscription::endTime, MSTransportableControl::get(), MSNet::getCurrentTimeStep(), MSNet::getInstance(), MSNet::getPersonControl(), TraCIServer::Subscription::id, myOutputStorage, mySubscriptionCache, mySubscriptions, myVehicleStateChanges, processSingleSubscription(), tcpip::Storage::reset(), RTYPE_OK, tcpip::Storage::size(), MSNet::VEHICLE_STATE_ARRIVED, tcpip::Storage::writeInt(), writeStatusCmd(), and tcpip::Storage::writeStorage().

Referenced by dispatchCommand(), and processCommandsUntilSimStep().

void TraCIServer::postProcessVTD ( )

Definition at line 256 of file TraCIServer.cpp.

References MSNet::getInstance(), MSVehicleControl::getVehicle(), MSNet::getVehicleControl(), myVTDControlledVehicles, and WRITE_WARNING.

Referenced by getInstance(), and MSNet::simulationStep().

void TraCIServer::processCommandsUntilSimStep ( SUMOTime step )

process all commands until the next SUMO simulation step. It is guaranteed that t->getTargetTime() >= myStep after call (except the case that a load or close command is received)s

Definition at line 439 of file TraCIServer.cpp.

References CMD_CLOSE, CMD_LOAD, CMD_SIMSTEP, dispatchCommand(), MSNet::getInstance(), TraCI::getLoadArgs(), myAmEmbedded, myCurrentSocket, myDoCloseConnection, myInputStorage, myOutputStorage, mySockets, myTargetTime, myVehicleStateChanges, nextTargetTime(), postProcessSimulationStep(), processReorderingRequests(), removeCurrentSocket(), tcpip::Storage::reset(), sendOutputToAll(), SIMTIME, tcpip::Storage::size(), tcpip::Storage::valid_pos(), and tcpip::SocketException::what().

Referenced by getInstance(), and MSNet::simulationStep().

void TraCIServer::processReorderingRequests ( )

private

checks for and processes reordering requests (relevant for multiple clients)

Definition at line 349 of file TraCIServer.cpp.

References mySocketReorderRequests, mySockets, and SIMTIME.

Referenced by processCommandsUntilSimStep().

bool TraCIServer::processSingleSubscription	(	const TraCIServer::Subscription &	s,
		tcpip::Storage &	writeInto,
		std::string &	errors
	)

private

int TraCIServer::readCommandID	(	int &	commandStart,
		int &	commandLength
	)

private

Reads the next command ID from the input storage.

Returns: the command ID

Parameters

[out] the version with reference parameters provides information on the command start position and length used in dispatchCommand for checking purposes

Definition at line 733 of file TraCIServer.cpp.

References myInputStorage, tcpip::Storage::position(), tcpip::Storage::readInt(), and tcpip::Storage::readUnsignedByte().

Referenced by checkClientOrdering(), and dispatchCommand().

bool TraCIServer::readTypeCheckingBoundary	(	tcpip::Storage &	inputStorage,
		Boundary &	into
	)

Reads the value type and a 2D bounding box, verifying the type.

Parameters

Definition at line 1420 of file TraCIServer.cpp.

References tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), Boundary::set(), and TYPE_BOUNDINGBOX.

Referenced by getVehicleStateChanges(), and TraCIServerAPI_GUI::processSet().

bool TraCIServer::readTypeCheckingByte	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and a byte, verifying the type.

Parameters

Definition at line 1434 of file TraCIServer.cpp.

References tcpip::Storage::readByte(), tcpip::Storage::readUnsignedByte(), and TYPE_BYTE.

Referenced by getVehicleStateChanges(), and TraCIServerAPI_Vehicle::processSet().

bool TraCIServer::readTypeCheckingColor	(	tcpip::Storage &	inputStorage,
		TraCIColor &	into
	)

Reads the value type and a color, verifying the type.

Parameters

Definition at line 1395 of file TraCIServer.cpp.

References TraCIColor::a, TraCIColor::b, TraCIColor::g, TraCIColor::r, tcpip::Storage::readUnsignedByte(), and TYPE_COLOR.

Referenced by getVehicleStateChanges(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_Vehicle::processSet(), and TraCIServerAPI_VehicleType::setVariable().

bool TraCIServer::readTypeCheckingDouble	(	tcpip::Storage &	inputStorage,
		double &	into
	)

Reads the value type and a double, verifying the type.

Parameters

Definition at line 1365 of file TraCIServer.cpp.

References tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), and TYPE_DOUBLE.

Referenced by getVehicleStateChanges(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Edge::processSet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_GUI::processSet(), TraCIServerAPI_Person::processSet(), TraCIServerAPI_Lane::processSet(), and TraCIServerAPI_VehicleType::setVariable().

bool TraCIServer::readTypeCheckingInt	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and an int, verifying the type.

Parameters

Definition at line 1355 of file TraCIServer.cpp.

References tcpip::Storage::readInt(), tcpip::Storage::readUnsignedByte(), and TYPE_INTEGER.

Referenced by getVehicleStateChanges(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Edge::processSet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_TLS::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_Vehicle::processSet(), and TraCIServerAPI_Person::processSet().

bool TraCIServer::readTypeCheckingPolygon	(	tcpip::Storage &	inputStorage,
		PositionVector &	into
	)

Reads the value type and a polygon, verifying the type.

Parameters

Definition at line 1454 of file TraCIServer.cpp.

References tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), and TYPE_POLYGON.

Referenced by getVehicleStateChanges(), and TraCIServerAPI_Polygon::processSet().

bool TraCIServer::readTypeCheckingPosition2D	(	tcpip::Storage &	inputStorage,
		TraCIPosition &	into
	)

Reads the value type and a 2D position, verifying the type.

Parameters

Definition at line 1408 of file TraCIServer.cpp.

References POSITION_2D, tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), TraCIPosition::x, TraCIPosition::y, and TraCIPosition::z.

Referenced by getVehicleStateChanges(), TraCIServerAPI_POI::processSet(), and TraCIServerAPI_GUI::processSet().

bool TraCIServer::readTypeCheckingString	(	tcpip::Storage &	inputStorage,
		std::string &	into
	)

Reads the value type and a string, verifying the type.

Parameters

Definition at line 1375 of file TraCIServer.cpp.

References tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), and TYPE_STRING.

bool TraCIServer::readTypeCheckingStringList	(	tcpip::Storage &	inputStorage,
		std::vector< std::string > &	into
	)

Reads the value type and a string list, verifying the type.

Parameters

Definition at line 1385 of file TraCIServer.cpp.

References tcpip::Storage::readStringList(), tcpip::Storage::readUnsignedByte(), and TYPE_STRINGLIST.

Referenced by dispatchCommand(), getVehicleStateChanges(), TraCIServerAPI_Edge::processSet(), TraCIServerAPI_Route::processSet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_Person::processSet(), and TraCIServerAPI_Lane::processSet().

bool TraCIServer::readTypeCheckingUnsignedByte	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and an unsigned byte, verifying the type.

Parameters

Definition at line 1444 of file TraCIServer.cpp.

References tcpip::Storage::readUnsignedByte(), and TYPE_UBYTE.

Referenced by TraCIServerAPI_Simulation::commandPositionConversion(), getVehicleStateChanges(), and TraCIServerAPI_Polygon::processSet().

std::map< int, TraCIServer::SocketInfo * >::iterator TraCIServer::removeCurrentSocket ( )

private

removes myCurrentSocket from mySockets and returns an iterator pointing to the next member according to the ordering

Definition at line 703 of file TraCIServer.cpp.

References myCurrentSocket, and mySockets.

Referenced by processCommandsUntilSimStep().

void TraCIServer::removeSubscription	(	int	commandId,
		const std::string &	identity,
		int	domain
	)

private

Definition at line 1072 of file TraCIServer.cpp.

References mySubscriptions, RTYPE_OK, and writeStatusCmd().

Referenced by addObjectVariableSubscription().

void TraCIServer::sendOutputToAll ( ) const

private

send out subscription results (actually just the content of myOutputStorage) to clients which will act in this step (i.e. with client target time <= myTargetTime)

Definition at line 417 of file TraCIServer.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), myOutputStorage, and mySockets.

Referenced by processCommandsUntilSimStep().

void TraCIServer::sendSingleSimStepResponse ( )

private

sends an empty response to a simstep command to the current client. (This applies to a situation where the TraCI step frequency is higher than the SUMO step frequency)

Definition at line 974 of file TraCIServer.cpp.

References CMD_SIMSTEP, myCurrentSocket, myOutputStorage, mySubscriptionCache, tcpip::Storage::reset(), RTYPE_OK, tcpip::Storage::size(), writeStatusCmd(), and tcpip::Storage::writeStorage().

Referenced by dispatchCommand().

void TraCIServer::setVTDControlled	(	MSVehicle *	v,
		Position	xyPos,
		MSLane *	l,
		double	pos,
		double	posLat,
		double	angle,
		int	edgeOffset,
		ConstMSEdgeVector	route,
		SUMOTime	t
	)

Definition at line 248 of file TraCIServer.cpp.

References MSBaseVehicle::getID(), MSVehicle::getInfluencer(), myVTDControlledVehicles, and MSVehicle::Influencer::setVTDControlled().

Referenced by getInstance(), and TraCIServerAPI_Vehicle::processSet().

void TraCIServer::vehicleStateChanged	(	const SUMOVehicle *const	vehicle,
		MSNet::VehicleState	to
	)

virtual

Called if a vehicle changes its state.

Parameters

[in]	vehicle	The vehicle which changed its state
[in]	to	The state the vehicle has changed to

Implements MSNet::VehicleStateListener.

Definition at line 272 of file TraCIServer.cpp.

References SUMOVehicle::getID(), myAmEmbedded, myDoCloseConnection, mySockets, and myVehicleStateChanges.

Referenced by getInstance().

bool TraCIServer::wasClosed ( )

static

check whether close was requested

Returns: Whether the connection was closed

Definition at line 242 of file TraCIServer.cpp.

References myDoCloseConnection.

Referenced by getInstance(), GUIRunThread::makeStep(), MSNet::simulate(), MSNet::simulationState(), and MSNet::simulationStep().

bool TraCIServer::writeErrorStatusCmd	(	int	commandId,
		const std::string &	description,
		tcpip::Storage &	outputStorage
	)

Writes a status command to the given storage with status = RTYPE_ERR.

Parameters

[in]	commandId	The id of the command to respond to
[in]	description	The status description (error message, for example)

Definition at line 1015 of file TraCIServer.cpp.

References RTYPE_ERR, and writeStatusCmd().

void TraCIServer::writeResponseWithLength	(	tcpip::Storage &	outputStorage,
		tcpip::Storage &	tempMsg
	)

void TraCIServer::writeStatusCmd	(	int	commandId,
		int	status,
		const std::string &	description,
		tcpip::Storage &	outputStorage
	)

Writes a status command to the given storage.

Parameters

[in]	commandId	The id of the command to respond to
[in]	status	The status to send
[in]	description	The status description (error message, for example)

Definition at line 1001 of file TraCIServer.cpp.

References RTYPE_ERR, RTYPE_NOTIMPLEMENTED, toHex(), WRITE_ERROR, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

void TraCIServer::writeStatusCmd	(	int	commandId,
		int	status,
		const std::string &	description
	)

Writes a status command to myOutputStorage.

Parameters

[in]	commandId	The id of the command to respond to
[in]	status	The status to send
[in]	description	The status description (error message, for example)

Definition at line 995 of file TraCIServer.cpp.

References myOutputStorage, and writeStatusCmd().

Field Documentation

const bool TraCIServer::myAmEmbedded

private

Whether the server runs in embedded mode.

Definition at line 383 of file TraCIServer.h.

Referenced by dispatchCommand(), getVehicleStateChanges(), isEmbedded(), processCommandsUntilSimStep(), TraCIServer(), and vehicleStateChanged().

std::map<int, SocketInfo*>::iterator TraCIServer::myCurrentSocket

private

The currently active client socket.

Definition at line 368 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), dispatchCommand(), getVehicleStateChanges(), processCommandsUntilSimStep(), removeCurrentSocket(), sendSingleSimStepResponse(), TraCIServer(), and ~TraCIServer().

bool TraCIServer::myDoCloseConnection = false

staticprivate

Whether the connection was set to be to close.

Definition at line 355 of file TraCIServer.h.

Referenced by close(), dispatchCommand(), openSocket(), processCommandsUntilSimStep(), TraCIServer(), vehicleStateChanged(), and wasClosed().

std::map<int, CmdExecutor> TraCIServer::myExecutors

private

Map of commandIds -> their executors; applicable if the executor applies to the method footprint.

Definition at line 386 of file TraCIServer.h.

Referenced by dispatchCommand(), openSocket(), processSingleSubscription(), and TraCIServer().

tcpip::Storage TraCIServer::myInputStorage

private

The storage to read from.

Definition at line 374 of file TraCIServer.h.

Referenced by addObjectVariableSubscription(), checkClientOrdering(), cleanup(), dispatchCommand(), processCommandsUntilSimStep(), and readCommandID().

TraCIServer * TraCIServer::myInstance = 0

staticprivate

Singleton instance of the server.

Definition at line 352 of file TraCIServer.h.

Referenced by cleanup(), close(), getInstance(), and openSocket().

LANE_RTREE_QUAL* TraCIServer::myLaneTree

private

A storage of lanes.

Definition at line 452 of file TraCIServer.h.

Referenced by cleanup(), and collectObjectsInRange().

std::map<int, NamedRTree*> TraCIServer::myObjects

private

A storage of objects.

Definition at line 449 of file TraCIServer.h.

Referenced by cleanup(), and collectObjectsInRange().

tcpip::Storage TraCIServer::myOutputStorage

private

The storage to writeto.

Definition at line 377 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), commandGetVersion(), dispatchCommand(), initialiseSubscription(), postProcessSimulationStep(), processCommandsUntilSimStep(), sendOutputToAll(), sendSingleSimStepResponse(), and writeStatusCmd().

std::map<int, int> TraCIServer::myParameterSizes

private

Map of variable ids to the size of the parameter in bytes.

Definition at line 389 of file TraCIServer.h.

Referenced by addObjectVariableSubscription(), and TraCIServer().

tcpip::Socket* TraCIServer::myServerSocket

private

The server socket.

Definition at line 358 of file TraCIServer.h.

Referenced by TraCIServer(), and ~TraCIServer().

std::map<int, SocketInfo*> TraCIServer::mySocketReorderRequests

private

This stores the setOrder(int) requests of the clients.

Definition at line 365 of file TraCIServer.h.

Referenced by dispatchCommand(), and processReorderingRequests().

std::map<int, SocketInfo*> TraCIServer::mySockets

private

The socket connections to the clients the first component (index) determines the client's order (lowest index's commands are processed first),.

See also: CMD_SETORDER

Definition at line 362 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), dispatchCommand(), getVehicleStateChanges(), nextTargetTime(), processCommandsUntilSimStep(), processReorderingRequests(), removeCurrentSocket(), sendOutputToAll(), TraCIServer(), vehicleStateChanged(), and ~TraCIServer().

tcpip::Storage TraCIServer::mySubscriptionCache

private

The last timestep's subscription results.

Definition at line 380 of file TraCIServer.h.

Referenced by cleanup(), initialiseSubscription(), postProcessSimulationStep(), and sendSingleSimStepResponse().

std::vector<Subscription> TraCIServer::mySubscriptions

private

The list of known, still valid subscriptions.

Definition at line 437 of file TraCIServer.h.

Referenced by cleanup(), initialiseSubscription(), postProcessSimulationStep(), and removeSubscription().

SUMOTime TraCIServer::myTargetTime

private

The time step to reach until processing the next commands.

Definition at line 371 of file TraCIServer.h.

Referenced by cleanup(), dispatchCommand(), getTargetTime(), and processCommandsUntilSimStep().

std::map<MSNet::VehicleState, std::vector<std::string> > TraCIServer::myVehicleStateChanges

private

Changes in the states of simulated vehicles.

Note: Server cache myVehicleStateChanges is used for managing last steps subscription updates and for client information in case that myAmEmbedded==true, which implies a single client. For the potential multiclient case (myAmEmbedded==false), each socket in mySockets is associated with a proper vehicleStateChanges container mySockets[...].second->vehicleStateChanges Performance could be improved if for a single client, myVehicleStateChanges is used only.

Definition at line 446 of file TraCIServer.h.

Referenced by cleanup(), dispatchCommand(), getVehicleStateChanges(), postProcessSimulationStep(), processCommandsUntilSimStep(), TraCIServer(), and vehicleStateChanged().

std::map<std::string, MSVehicle*> TraCIServer::myVTDControlledVehicles

private

Definition at line 391 of file TraCIServer.h.

Referenced by postProcessVTD(), and setVTDControlled().

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation