opflex::test::MockOpflexServer Class Reference

An opflex server we can use for mocking interactions with a real Opflex server. More...

#include <opflex/test/MockOpflexServer.h>

Public Types
typedef std::pair< uint8_t, std::string >	peer_t
	a pair of a role bitmask and connectivity string
typedef std::vector< peer_t >	peer_vec_t
	A vector of peers.

Public Member Functions
	MockOpflexServer (int port, uint8_t roles, peer_vec_t peers, const modb::ModelMetadata &md)
	Construct a new mock opflex server. More...
	~MockOpflexServer ()
	Destroy the opflex server.
void	start ()
	Start the server.
void	stop ()
	Stop the server.
void	readPolicy (const std::string &file)
	Read policy into the server from the specified file. More...
void	enableSSL (const std::string &caStorePath, const std::string &serverKeyPath, const std::string &serverKeyPass, bool verifyPeers=true)
	Enable SSL for connections to opflex peers. More...
const peer_vec_t &	getPeers () const
	Get the peers that this server was configured with. More...
int	getPort () const
	Get the port number that this server was configured with. More...
uint8_t	getRoles () const
	Get the roles that this server was configured with. More...

Detailed Description

An opflex server we can use for mocking interactions with a real Opflex server.

Constructor & Destructor Documentation

opflex::test::MockOpflexServer::MockOpflexServer	(	int	port,
		uint8_t	roles,
		peer_vec_t	peers,
		const modb::ModelMetadata &	md
	)

Construct a new mock opflex server.

Parameters

port	listen port for the server
roles	the opflex roles for this server
peers	a list of peers to return in the opflex handshake
md	the model metadata for the server

Member Function Documentation

void opflex::test::MockOpflexServer::enableSSL	(	const std::string &	caStorePath,
		const std::string &	serverKeyPath,
		const std::string &	serverKeyPass,
		bool	verifyPeers = true
	)

Enable SSL for connections to opflex peers.

Call before start()

Parameters

caStorePath	the filesystem path to a directory containing CA certificates, or to a file containing a specific CA certificate.
serverKeyPath	the path to the server private key
serverKeyPass	the passphrase for the server private key
verifyPeers	set to true to verify that peer certificates properly chain to a trusted root

const peer_vec_t& opflex::test::MockOpflexServer::getPeers

(

)

const

Get the peers that this server was configured with.

Returns

a vector of peer pairs

int opflex::test::MockOpflexServer::getPort

(

)

const

Get the port number that this server was configured with.

Returns

the port number

uint8_t opflex::test::MockOpflexServer::getRoles

(

)

const

Get the roles that this server was configured with.

Returns

a bitmask containing the server roles

void opflex::test::MockOpflexServer::readPolicy

(

const std::string &

file

)

Read policy into the server from the specified file.

Note that this will not automatically cause updates to be sent to connected clients.

Parameters

file	the filename to read in

---

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

• MockOpflexServer.h