Infinity.AdoptedSessionReplay

g GObject.Object GObject.Object Infinity.AdoptedSessionReplay Infinity.AdoptedSessionReplay GObject.Object->Infinity.AdoptedSessionReplay

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

get_session ()

play_next ()

play_to_end ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

filename

str

r

The filename of the record to play

session

Infinity.AdoptedSession

r

The replayed session

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

GObject.Object

r

Class Details

class Infinity.AdoptedSessionReplay(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Infinity.AdoptedSessionReplayClass

Infinity.AdoptedSessionReplay is an opaque data type. You should only access it via the public API functions.

classmethod new()
Returns:

A new Infinity.AdoptedSessionReplay. Free with GObject.Object.unref() when no longer in use.

Return type:

Infinity.AdoptedSessionReplay

Creates a new Infinity.AdoptedSessionReplay. Use inf_adopted_session_replay_set_record() to start the recording, and Infinity.AdoptedSessionReplay.play_next() or Infinity.AdoptedSessionReplay.play_to_end() to play it.

get_session()
Returns:

A Infinity.AdoptedSessionReplay, or None.

Return type:

Infinity.AdoptedSession

Returns the played back session, or None if inf_adopted_session_replay_set_record() was not yet called.

play_next()
Raises:

GLib.Error

Returns:

True if a request was read, otherwise False.

Return type:

bool

Reads the next request from the record and passes it to the session. Note that this might do nothing if that request is not yet causally ready, meaning that it depends on another request that has not yet been played. In that case it will be executed as soon as it is ready, that is after some future Infinity.AdoptedSessionReplay.play_next() call. Therefore, it is also possible that this function executes more than one request.

If an error occurs, then this function returns False and error is set. If the end of the recording is reached, then it also returns False, but error is left untouched. If the next request has been read, then it returns True.

play_to_end()
Raises:

GLib.Error

Returns:

True on success, or False if an error occurs.

Return type:

bool

Plays all requests that are contained in the recording, so that the replay’s session has the same state as the recorded session when the recording was stopped.

Note that, depending on the size of the record, this function may take some time to finish.

If an error occurs during replay, then the function returns False and error is set. Otherwise it returns True.

Property Details

Infinity.AdoptedSessionReplay.props.filename
Name:

filename

Type:

str

Default Value:

None

Flags:

READABLE

The filename of the record to play

Infinity.AdoptedSessionReplay.props.session
Name:

session

Type:

Infinity.AdoptedSession

Default Value:

None

Flags:

READABLE

The replayed session