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

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...

typedef bool(*	SubscriptionHandler) (const std::string &objID, const int variable, VariableWrapper *wrapper)
	Definition of a method to be called for serving an associated commandID. More...

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

std::vector< std::string > &	getLoadArgs ()

SUMOTime	getTargetTime () const

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

bool	isEmbedded () const

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...

virtual void	setContext (const std::string &)

void	setTargetTime (SUMOTime targetTime)
	Sets myTargetTime on server and sockets to the given value. More...

void	vehicleStateChanged (const SUMOVehicle *const vehicle, MSNet::VehicleState to, const std::string &info="")
	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, libsumo::TraCIColor &into)
	Reads the value type and a color, verifying the type. More...

bool	readTypeCheckingPosition2D (tcpip::Storage &inputStorage, libsumo::TraCIPosition &into)
	Reads the value type and a 2D position, 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...

VariableWrapper interface
void	initWrapper (const int domainID, const int variable, const std::string &objID)

bool	wrapDouble (const std::string &objID, const int variable, const double value)

bool	wrapInt (const std::string &objID, const int variable, const int value)

bool	wrapString (const std::string &objID, const int variable, const std::string &value)

bool	wrapStringList (const std::string &objID, const int variable, const std::vector< std::string > &value)

bool	wrapPosition (const std::string &objID, const int variable, const libsumo::TraCIPosition &value)

bool	wrapColor (const std::string &objID, const int variable, const libsumo::TraCIColor &value)

tcpip::Storage &	getWrapperStorage ()

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...

Data Fields
SubscriptionHandler	handle

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

bool	addSubscriptionFilter ()

void	addSubscriptionFilterCFManeuver ()

void	addSubscriptionFilterDownstreamDistance (double dist)

void	addSubscriptionFilterLanes (std::vector< int > lanes)

void	addSubscriptionFilterLCManeuver ()

void	addSubscriptionFilterNoOpposite ()

void	addSubscriptionFilterTurnManeuver ()

void	addSubscriptionFilterUpstreamDistance (double dist)

void	addSubscriptionFilterVClass (SVCPermissions vClasses)

void	addSubscriptionFilterVType (std::vector< std::string > vTypes)

bool	centralObject (const libsumo::Subscription &s, const std::string &objID)
	check whether a found objID refers to the central object of a context subscription More...

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 (libsumo::Subscription &s)

bool	isVehicleToVehicleContextSubscription (const libsumo::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 libsumo::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	removeFilters ()

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...

libsumo::Subscription *	myLastContextSubscription
	The last modified context subscription (the one to add a filter to, see (), currently only for vehicle to vehicle context) More...

std::vector< std::string >	myLoadArgs

tcpip::Storage	myOutputStorage
	The storage to write to. 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< libsumo::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...

tcpip::Storage	myWrapperStorage
	A temporary storage to let the wrapper write to. More...

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 62 of file TraCIServer.h.

Member Typedef Documentation

◆ CmdExecutor

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 65 of file TraCIServer.h.

◆ SubscriptionHandler

typedef bool(* libsumo::VariableWrapper::SubscriptionHandler) (const std::string &objID, const int variable, VariableWrapper *wrapper)

inherited

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

Definition at line 115 of file Subscription.h.

Constructor & Destructor Documentation

◆ TraCIServer()

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 174 of file TraCIServer.cpp.

Referenced by getLoadArgs(), and openSocket().

◆ ~TraCIServer()

TraCIServer::~TraCIServer ( )

privatevirtual

Destructor.

Definition at line 262 of file TraCIServer.cpp.

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

Referenced by getLoadArgs().

Member Function Documentation

◆ addObjectVariableSubscription()

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

private

Definition at line 1259 of file TraCIServer.cpp.

References initialiseSubscription(), INVALID_DOUBLE_VALUE, myInputStorage, myParameterSizes, tcpip::Storage::readChar(), tcpip::Storage::readDouble(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), removeSubscription(), STEPS2TIME, SUMOTime_MAX, and TIME2STEPS.

Referenced by dispatchCommand().

◆ addSubscriptionFilter()

bool TraCIServer::addSubscriptionFilter ( )

private

Definition at line 1292 of file TraCIServer.cpp.

Referenced by dispatchCommand().

◆ addSubscriptionFilterCFManeuver()

void TraCIServer::addSubscriptionFilterCFManeuver ( )

private

Definition at line 1405 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_CF_MANEUVER.

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterDownstreamDistance()

void TraCIServer::addSubscriptionFilterDownstreamDistance ( double dist )

private

Definition at line 1387 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterDownstreamDist, myLastContextSubscription, libsumo::SUBS_FILTER_DOWNSTREAM_DIST, and toString().

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterLanes()

void TraCIServer::addSubscriptionFilterLanes ( std::vector< int > lanes )

private

Definition at line 1370 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterLanes, myLastContextSubscription, libsumo::SUBS_FILTER_LANES, and toString().

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterLCManeuver()

void TraCIServer::addSubscriptionFilterLCManeuver ( )

private

Definition at line 1413 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_LC_MANEUVER.

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterNoOpposite()

void TraCIServer::addSubscriptionFilterNoOpposite ( )

private

Definition at line 1379 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_NOOPPOSITE.

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterTurnManeuver()

void TraCIServer::addSubscriptionFilterTurnManeuver ( )

private

Definition at line 1421 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_TURN_MANEUVER.

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterUpstreamDistance()

void TraCIServer::addSubscriptionFilterUpstreamDistance ( double dist )

private

Definition at line 1396 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterUpstreamDist, myLastContextSubscription, libsumo::SUBS_FILTER_UPSTREAM_DIST, and toString().

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterVClass()

void TraCIServer::addSubscriptionFilterVClass ( SVCPermissions vClasses )

private

Definition at line 1429 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterVClasses, myLastContextSubscription, libsumo::SUBS_FILTER_VCLASS, and toString().

Referenced by addSubscriptionFilter().

◆ addSubscriptionFilterVType()

void TraCIServer::addSubscriptionFilterVType ( std::vector< std::string > vTypes )

private

Definition at line 1438 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterVTypes, myLastContextSubscription, libsumo::SUBS_FILTER_VTYPE, and toString().

Referenced by addSubscriptionFilter().

◆ centralObject()

bool TraCIServer::centralObject	(	const libsumo::Subscription &	s,
		const std::string &	objID
	)

private

check whether a found objID refers to the central object of a context subscription

Definition at line 1568 of file TraCIServer.cpp.

References libsumo::Subscription::commandId, libsumo::Subscription::contextDomain, and libsumo::Subscription::id.

◆ checkClientOrdering()

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 328 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().

◆ cleanup()

void TraCIServer::cleanup ( )

clean up subscriptions

Definition at line 641 of file TraCIServer.cpp.

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

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

◆ close()

void TraCIServer::close ( )

static

request termination of connection

Definition at line 295 of file TraCIServer.cpp.

References myDoCloseConnection, and myInstance.

Referenced by getInstance(), and main().

◆ commandGetVersion()

bool TraCIServer::commandGetVersion ( )

private

Returns the TraCI-version.

Returns: Always true

Definition at line 944 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().

◆ dispatchCommand()

int TraCIServer::dispatchCommand ( )

private

Handles command, writes response to myOutputStorage.

Definition at line 781 of file TraCIServer.cpp.

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

◆ findObjectShape()

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

private

◆ getInstance()

static TraCIServer* TraCIServer::getInstance ( void )

inlinestatic

Definition at line 73 of file TraCIServer.h.

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

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

◆ getLoadArgs()

std::vector<std::string>& TraCIServer::getLoadArgs ( )

inline

Definition at line 250 of file TraCIServer.h.

References getWrapperStorage(), initWrapper(), myLoadArgs, TraCIServer(), wrapColor(), wrapDouble(), wrapInt(), wrapPosition(), wrapString(), wrapStringList(), and ~TraCIServer().

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

◆ getTargetTime()

SUMOTime TraCIServer::getTargetTime ( ) const

inline

Definition at line 67 of file TraCIServer.h.

References myTargetTime.

Referenced by MSNet::simulationStep().

◆ getVehicleStateChanges()

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

inline

Definition at line 146 of file TraCIServer.h.

References myAmEmbedded, myCurrentSocket, mySockets, myVehicleStateChanges, readTypeCheckingByte(), readTypeCheckingColor(), readTypeCheckingDouble(), readTypeCheckingInt(), readTypeCheckingPolygon(), readTypeCheckingPosition2D(), readTypeCheckingString(), readTypeCheckingStringList(), readTypeCheckingUnsignedByte(), setTargetTime(), and writeResponseWithLength().

Referenced by TraCIServerAPI_Simulation::writeVehicleStateIDs(), and TraCIServerAPI_Simulation::writeVehicleStateNumber().

◆ getWrapperStorage()

tcpip::Storage & TraCIServer::getWrapperStorage ( )

Definition at line 168 of file TraCIServer.cpp.

References myWrapperStorage.

◆ initialiseSubscription()

void TraCIServer::initialiseSubscription ( libsumo::Subscription & s )

private

Definition at line 1070 of file TraCIServer.cpp.

Referenced by addObjectVariableSubscription().

◆ initWrapper()

void TraCIServer::initWrapper	(	const int	domainID,
		const int	variable,
		const std::string &	objID
	)

◆ isEmbedded()

bool TraCIServer::isEmbedded ( ) const

inline

Definition at line 70 of file TraCIServer.h.

References myAmEmbedded.

Referenced by MSNet::simulationStep().

◆ isVehicleToVehicleContextSubscription()

bool TraCIServer::isVehicleToVehicleContextSubscription ( const libsumo::Subscription & s )

private

Definition at line 1154 of file TraCIServer.cpp.

References CMD_GET_VEHICLE_VARIABLE, CMD_SUBSCRIBE_VEHICLE_CONTEXT, libsumo::Subscription::commandId, and libsumo::Subscription::contextDomain.

Referenced by initialiseSubscription().

◆ nextTargetTime()

SUMOTime TraCIServer::nextTargetTime ( ) const

private

get the minimal next target time among all clients

Definition at line 437 of file TraCIServer.cpp.

References MIN2(), and mySockets.

Referenced by processCommandsUntilSimStep().

◆ openSocket()

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 273 of file TraCIServer.cpp.

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

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

◆ operator=()

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

private

Invalidated assignment operator.

◆ postProcessSimulationStep()

void TraCIServer::postProcessSimulationStep ( )

private

Handles subscriptions to send after a simstep2 command.

Definition at line 963 of file TraCIServer.cpp.

References libsumo::Subscription::beginTime, CMD_SIMSTEP, CMD_SUBSCRIBE_PERSON_CONTEXT, CMD_SUBSCRIBE_PERSON_VARIABLE, CMD_SUBSCRIBE_VEHICLE_CONTEXT, CMD_SUBSCRIBE_VEHICLE_VARIABLE, libsumo::Subscription::commandId, libsumo::Subscription::endTime, MSTransportableControl::get(), MSNet::getCurrentTimeStep(), MSNet::getInstance(), MSNet::getPersonControl(), libsumo::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().

◆ processCommandsUntilSimStep()

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 483 of file TraCIServer.cpp.

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

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

◆ processReorderingRequests()

void TraCIServer::processReorderingRequests ( )

private

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

Definition at line 393 of file TraCIServer.cpp.

References mySocketReorderRequests, mySockets, and SIMTIME.

Referenced by processCommandsUntilSimStep().

◆ processSingleSubscription()

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

private

◆ readCommandID()

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 770 of file TraCIServer.cpp.

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

Referenced by checkClientOrdering(), and dispatchCommand().

◆ readTypeCheckingByte()

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

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

Parameters

Definition at line 1523 of file TraCIServer.cpp.

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

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

◆ readTypeCheckingColor()

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

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

Parameters

Definition at line 1498 of file TraCIServer.cpp.

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

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

◆ readTypeCheckingDouble()

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

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

Parameters

Definition at line 1468 of file TraCIServer.cpp.

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

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

◆ readTypeCheckingInt()

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

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

Parameters

Definition at line 1458 of file TraCIServer.cpp.

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

Referenced by getVehicleStateChanges(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Simulation::processGet(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_TrafficLight::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_Vehicle::processSet(), TraCIServerAPI_GUI::processSet(), and TraCIServerAPI_Person::processSet().

◆ readTypeCheckingPolygon()

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

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

Parameters

Definition at line 1543 of file TraCIServer.cpp.

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

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

◆ readTypeCheckingPosition2D()

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

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

Parameters

Definition at line 1511 of file TraCIServer.cpp.

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

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

◆ readTypeCheckingString()

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

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

Parameters

Definition at line 1478 of file TraCIServer.cpp.

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

◆ readTypeCheckingStringList()

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 1488 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().

◆ readTypeCheckingUnsignedByte()

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

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

Parameters

Definition at line 1533 of file TraCIServer.cpp.

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

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

◆ removeCurrentSocket()

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 740 of file TraCIServer.cpp.

References myCurrentSocket, and mySockets.

Referenced by processCommandsUntilSimStep().

◆ removeFilters()

void TraCIServer::removeFilters ( )

private

Definition at line 1362 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_NONE.

Referenced by addSubscriptionFilter().

◆ removeSubscription()

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

private

Definition at line 1130 of file TraCIServer.cpp.

References myLastContextSubscription, mySubscriptions, RTYPE_ERR, RTYPE_OK, and writeStatusCmd().

Referenced by addObjectVariableSubscription().

◆ sendOutputToAll()

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 461 of file TraCIServer.cpp.

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

Referenced by processCommandsUntilSimStep().

◆ sendSingleSimStepResponse()

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 1022 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().

◆ setContext()

virtual void libsumo::VariableWrapper::setContext ( const std::string & )

inlinevirtualinherited

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 118 of file Subscription.h.

◆ setTargetTime()

void TraCIServer::setTargetTime ( SUMOTime targetTime )

Sets myTargetTime on server and sockets to the given value.

Note: Used in MSStateHandler to update the server's time after loading a state

Definition at line 1560 of file TraCIServer.cpp.

References mySockets, and myTargetTime.

Referenced by NLBuilder::build(), and getVehicleStateChanges().

◆ vehicleStateChanged()

void TraCIServer::vehicleStateChanged	(	const SUMOVehicle *const	vehicle,
		MSNet::VehicleState	to,
		const std::string &	info = `""`
	)

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
[in]	info	Additional information on the state change

Implements MSNet::VehicleStateListener.

Definition at line 315 of file TraCIServer.cpp.

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

Referenced by getInstance().

◆ wasClosed()

bool TraCIServer::wasClosed ( )

static

check whether close was requested

Returns: Whether the connection was closed

Definition at line 306 of file TraCIServer.cpp.

References myDoCloseConnection.

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

◆ wrapColor()

bool TraCIServer::wrapColor	(	const std::string &	objID,
		const int	variable,
		const libsumo::TraCIColor &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 157 of file TraCIServer.cpp.

References libsumo::TraCIColor::a, libsumo::TraCIColor::b, libsumo::TraCIColor::g, myWrapperStorage, libsumo::TraCIColor::r, TYPE_COLOR, and tcpip::Storage::writeUnsignedByte().

Referenced by getLoadArgs().

◆ wrapDouble()

bool TraCIServer::wrapDouble	(	const std::string &	objID,
		const int	variable,
		const double	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 112 of file TraCIServer.cpp.

References myWrapperStorage, TYPE_DOUBLE, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

Referenced by getLoadArgs().

◆ wrapInt()

bool TraCIServer::wrapInt	(	const std::string &	objID,
		const int	variable,
		const int	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 120 of file TraCIServer.cpp.

References myWrapperStorage, TYPE_INTEGER, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

Referenced by getLoadArgs().

◆ wrapPosition()

bool TraCIServer::wrapPosition	(	const std::string &	objID,
		const int	variable,
		const libsumo::TraCIPosition &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 144 of file TraCIServer.cpp.

References myWrapperStorage, POSITION_2D, POSITION_3D, VAR_POSITION3D, tcpip::Storage::writeDouble(), tcpip::Storage::writeUnsignedByte(), libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

Referenced by getLoadArgs().

◆ wrapString()

bool TraCIServer::wrapString	(	const std::string &	objID,
		const int	variable,
		const std::string &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 128 of file TraCIServer.cpp.

References myWrapperStorage, TYPE_STRING, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by getLoadArgs().

◆ wrapStringList()

bool TraCIServer::wrapStringList	(	const std::string &	objID,
		const int	variable,
		const std::vector< std::string > &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 136 of file TraCIServer.cpp.

References myWrapperStorage, TYPE_STRINGLIST, tcpip::Storage::writeStringList(), and tcpip::Storage::writeUnsignedByte().

Referenced by getLoadArgs().

◆ writeErrorStatusCmd()

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 1063 of file TraCIServer.cpp.

References RTYPE_ERR, and writeStatusCmd().

◆ writeResponseWithLength()

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

◆ writeStatusCmd() [1/2]

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 1049 of file TraCIServer.cpp.

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

◆ writeStatusCmd() [2/2]

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 1043 of file TraCIServer.cpp.

References myOutputStorage, and writeStatusCmd().

Field Documentation

◆ handle

SubscriptionHandler libsumo::VariableWrapper::handle

inherited

Definition at line 117 of file Subscription.h.

◆ myAmEmbedded

const bool TraCIServer::myAmEmbedded

private

Whether the server runs in embedded mode.

Definition at line 377 of file TraCIServer.h.

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

◆ myCurrentSocket

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

private

The currently active client socket.

Definition at line 359 of file TraCIServer.h.

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

◆ myDoCloseConnection

bool TraCIServer::myDoCloseConnection = false

staticprivate

Whether the connection was set to be to close.

Definition at line 346 of file TraCIServer.h.

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

◆ myExecutors

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

private

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

Definition at line 380 of file TraCIServer.h.

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

◆ myInputStorage

tcpip::Storage TraCIServer::myInputStorage

private

The storage to read from.

Definition at line 365 of file TraCIServer.h.

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

◆ myInstance

TraCIServer * TraCIServer::myInstance = 0

staticprivate

Singleton instance of the server.

Definition at line 343 of file TraCIServer.h.

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

◆ myLastContextSubscription

libsumo::Subscription* TraCIServer::myLastContextSubscription

private

The last modified context subscription (the one to add a filter to, see (), currently only for vehicle to vehicle context)

Definition at line 391 of file TraCIServer.h.

Referenced by addSubscriptionFilterCFManeuver(), addSubscriptionFilterDownstreamDistance(), addSubscriptionFilterLanes(), addSubscriptionFilterLCManeuver(), addSubscriptionFilterNoOpposite(), addSubscriptionFilterTurnManeuver(), addSubscriptionFilterUpstreamDistance(), addSubscriptionFilterVClass(), addSubscriptionFilterVType(), initialiseSubscription(), removeFilters(), and removeSubscription().

◆ myLoadArgs

std::vector<std::string> TraCIServer::myLoadArgs

private

Definition at line 385 of file TraCIServer.h.

Referenced by dispatchCommand(), getLoadArgs(), and processCommandsUntilSimStep().

◆ myOutputStorage

tcpip::Storage TraCIServer::myOutputStorage

private

The storage to write to.

Definition at line 368 of file TraCIServer.h.

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

◆ myParameterSizes

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

private

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

Definition at line 383 of file TraCIServer.h.

Referenced by addObjectVariableSubscription(), and TraCIServer().

◆ myServerSocket

tcpip::Socket* TraCIServer::myServerSocket

private

The server socket.

Definition at line 349 of file TraCIServer.h.

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

◆ mySocketReorderRequests

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

private

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

Definition at line 356 of file TraCIServer.h.

Referenced by dispatchCommand(), and processReorderingRequests().

◆ mySockets

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 353 of file TraCIServer.h.

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

◆ mySubscriptionCache

tcpip::Storage TraCIServer::mySubscriptionCache

private

The last timestep's subscription results.

Definition at line 374 of file TraCIServer.h.

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

◆ mySubscriptions

std::vector<libsumo::Subscription> TraCIServer::mySubscriptions

private

The list of known, still valid subscriptions.

Definition at line 388 of file TraCIServer.h.

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

◆ myTargetTime

SUMOTime TraCIServer::myTargetTime

private

The time step to reach until processing the next commands.

Definition at line 362 of file TraCIServer.h.

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

◆ myVehicleStateChanges

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 400 of file TraCIServer.h.

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

◆ myWrapperStorage

tcpip::Storage TraCIServer::myWrapperStorage

private

A temporary storage to let the wrapper write to.

Definition at line 371 of file TraCIServer.h.

Referenced by getWrapperStorage(), initWrapper(), wrapColor(), wrapDouble(), wrapInt(), wrapPosition(), wrapString(), and wrapStringList().

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CmdExecutor

◆ SubscriptionHandler

Constructor & Destructor Documentation

◆ TraCIServer()

◆ ~TraCIServer()

Member Function Documentation

◆ addObjectVariableSubscription()

◆ addSubscriptionFilter()

◆ addSubscriptionFilterCFManeuver()

◆ addSubscriptionFilterDownstreamDistance()

◆ addSubscriptionFilterLanes()

◆ addSubscriptionFilterLCManeuver()

◆ addSubscriptionFilterNoOpposite()

◆ addSubscriptionFilterTurnManeuver()

◆ addSubscriptionFilterUpstreamDistance()

◆ addSubscriptionFilterVClass()

◆ addSubscriptionFilterVType()

◆ centralObject()

◆ checkClientOrdering()

◆ cleanup()

◆ close()

◆ commandGetVersion()

◆ dispatchCommand()

◆ findObjectShape()

◆ getInstance()

◆ getLoadArgs()

◆ getTargetTime()

◆ getVehicleStateChanges()

◆ getWrapperStorage()

◆ initialiseSubscription()

◆ initWrapper()

◆ isEmbedded()

◆ isVehicleToVehicleContextSubscription()

◆ nextTargetTime()

◆ openSocket()

◆ operator=()

◆ postProcessSimulationStep()

◆ processCommandsUntilSimStep()

◆ processReorderingRequests()

◆ processSingleSubscription()

◆ readCommandID()

◆ readTypeCheckingByte()

◆ readTypeCheckingColor()

◆ readTypeCheckingDouble()

◆ readTypeCheckingInt()

◆ readTypeCheckingPolygon()

◆ readTypeCheckingPosition2D()

◆ readTypeCheckingString()

◆ readTypeCheckingStringList()

◆ readTypeCheckingUnsignedByte()

◆ removeCurrentSocket()

◆ removeFilters()

◆ removeSubscription()

◆ sendOutputToAll()

◆ sendSingleSimStepResponse()

◆ setContext()

◆ setTargetTime()

◆ vehicleStateChanged()

◆ wasClosed()

◆ wrapColor()

◆ wrapDouble()

◆ wrapInt()

◆ wrapPosition()

◆ wrapString()

◆ wrapStringList()

◆ writeErrorStatusCmd()

◆ writeResponseWithLength()

◆ writeStatusCmd() [1/2]

◆ writeStatusCmd() [2/2]

Field Documentation