A reven server. This is the root api object.

e.g: >>> import reven2 as rvn2

>>> reven_server = rvn2.RevenServer("localhost", 13370)
>>> reven_server
Reven server (localhost:13370) [connected]

>>> reven_server.host
localhost

>>> reven_server.port
13370

>>> reven_server.is_connected()
True

>>> reven_server.disconnect()
>>> reven_server.status()
disconnected

>>> reven_server.connect()
>>> reven_server.status()
connected

Method	__init__	Connect to a Reven server.
Method	host	Property: The reven host.
Method	port	Property: The reven port.
Method	is_connected	Check the current connection status.
Method	connect	Connect to the reven host.
Method	disconnect	Disconnect from the reven host.
Method	status	Get the connection status string.
Method	trace	Property: Get a `reven2.trace.Trace` instance, which is the entry point for information related to a trace, mostly transitions & contexts.
Method	ossi	Property: Get a `reven2.ossi.Ossi` instance, which is the entry point for information related to OSSI (OS Semantic Information) such as executed binaries.
Method	sessions	Property: Get a `reven2.session.Sessions` instance, which is the entry point for handling the tracked sessions or manually publishing events.
Method	bookmarks	Property: Get a `reven2.bookmark.Bookmarks` instance, which is the entry point for handling the bookmarks of this scenario.
Method	__repr__	Undocumented

def __init__(self, host, port, sessions='default'):

Connect to a Reven server.

Parameters	host	The reven host.
	port	The reven port.
	sessions	The `reven2.session.Sessions` to track when publishing events (such as transitions). Set a string to track a single named session, or pass a generator of strings to track all sessions in that generator.

@property
def host(self):

Property: The reven host.

Information

Returns A string.

@property
def port(self):

Property: The reven port.

Information

Returns An integer.

def is_connected(self):

Check the current connection status.

Information

Parameters	sessions	The `reven2.session.Sessions` to track when publishing events (such as transitions). Set a string to track a single named session, or pass a generator of strings to track all sessions in that generator.
Returns	`True`, if the connection with the server is currently open. Otherwise, `False`.

def connect(self, sessions='default'):

Connect to the reven host.

Use this method after having called disconnect to renew a connection to the server.

Information

Raises RuntimeError If the connection is lost, in case of bad input, or in case of internal service error.

def disconnect(self):

Disconnect from the reven host.

This method immediately closes the connection to the server. Use this method to avoid locking a licence token by keeping connections longer than wanted.

Note

Closing the last connection to a REVEN server releases its licence token.

After calling this method, the is_connected method will return False at least until the connect method is called.

After calling this method on a project, objects obtained from the server should not be used anymore. Calls to some of their methods may then raise RuntimeError exceptions.

def status(self):

Get the connection status string.

Information

Returns "connected" if currently connected, "disconnected" otherwise.

@property
def trace(self):

Property: Get a reven2.trace.Trace instance, which is the entry point for information related to a trace, mostly transitions & contexts.

Information

Returns	A `reven2.trace.Trace`.
Raises	Exception	If the server status is disconnected.

@property
def ossi(self):

Property: Get a reven2.ossi.Ossi instance, which is the entry point for information related to OSSI (OS Semantic Information) such as executed binaries.

Information

Returns	A `reven2.ossi.Ossi`.
Raises	Exception	If the server status is disconnected.

@property
def sessions(self):

Property: Get a reven2.session.Sessions instance, which is the entry point for handling the tracked sessions or manually publishing events.

Information

Returns	A `reven2.session.Sessions`.
Raises	Exception	If the server status is disconnected.

@property
def bookmarks(self):

Property: Get a reven2.bookmark.Bookmarks instance, which is the entry point for handling the bookmarks of this scenario.

Information

Returns A reven2.bookmark.Bookmarks.

def __repr__(self):

Undocumented

reven2.prelude.RevenServer(object) class documentation

Information

Information

Information

Information

Information

Information

Information

Information

Information

`reven2.prelude.RevenServer(object)` class documentation