Quantum.Experimental.QuantumSnapshotProviderDemo Class Reference

An example to customize requested snapshot uploading. This is marked experimental because it requires additional work when saving data on frame contex. More...

Inheritance diagram for Quantum.Experimental.QuantumSnapshotProviderDemo:

Public Member Functions
FrameSnapshot[]	GetSnapshot ()
	Returns the completed encoded snapshot. More...
void	Init (DeterministicSession session, IDisposable frameContext)
	Initializing the snapshot provider for this Quantum session. Used to create a frame container. More...
void	RequestSnapshot (DeterministicSession session, int referenceTick)
	Requesting a snapshot, use to CopyFrom and start async computation. More...

Public Attributes
int	ExtraHeapCount => 1
	The frame is copied before being serialized in on a worked thread. This requires an extra frame heap. More...
bool	IsCompleted => _task != null && _task.IsCompleted
	Returns true when a snapshot is read to be completed. More...

Additional Inherited Members
Properties inherited from Photon.Deterministic.IDeterministicSnapshotProvider
int	ExtraHeapCount [get]
	Return the number of additional frame heaps required for this tool to work. More...
bool	IsCompleted [get]
	Returns true when a snapshot is read to be completed. More...

Detailed Description

An example to customize requested snapshot uploading. This is marked experimental because it requires additional work when saving data on frame contex.

Member Function Documentation

GetSnapshot()

FrameSnapshot [] Quantum.Experimental.QuantumSnapshotProviderDemo.GetSnapshot ( )

inline

Returns the completed encoded snapshot.

Implements Photon.Deterministic.IDeterministicSnapshotProvider.

Init()

void Quantum.Experimental.QuantumSnapshotProviderDemo.Init ( DeterministicSession  session, IDisposable  frameContext  )

inline

Initializing the snapshot provider for this Quantum session. Used to create a frame container.

Implements Photon.Deterministic.IDeterministicSnapshotProvider.

RequestSnapshot()

void Quantum.Experimental.QuantumSnapshotProviderDemo.RequestSnapshot ( DeterministicSession  session, int  referenceTick  )

inline

Requesting a snapshot, use to CopyFrom and start async computation.

Implements Photon.Deterministic.IDeterministicSnapshotProvider.

Member Data Documentation

ExtraHeapCount

int Quantum.Experimental.QuantumSnapshotProviderDemo.ExtraHeapCount => 1

The frame is copied before being serialized in on a worked thread. This requires an extra frame heap.

IsCompleted

bool Quantum.Experimental.QuantumSnapshotProviderDemo.IsCompleted => _task != null && _task.IsCompleted

Returns true when a snapshot is read to be completed.