Base context for encoding and decoding More...

Inheritance diagram for pluginbase.Objects.Syncable.BaseContext:

Public Member Functions
void	Increment ()
	Increment reads of a context More...

void	Fail ()
	Failed a context More...

void	Reset ()
	Reset this instance to make it reusable More...

Public Attributes
readonly SyncableEndpoint	Endpoint
	The mode in which to decode content More...

readonly IFrameTimeState	TimeState
	The time state of this frame More...

Protected Member Functions
	BaseContext (SyncableEndpoint endpoint, IFrameTimeState timeState)
	Creates an instance of the context More...

Protected Attributes
const int	SIMULATE_FREQUENCY_PER_SECOND = 15
	The default frequency per-second More...

Properties
int	ReadCount `[get]`
	How many reads ocurred in this context More...

bool	Failed `[get]`
	Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed. More...

bool	EmptyOrFailed `[get]`
	Are we empty or a failure? More...

Detailed Description

Base context for encoding and decoding

Constructor & Destructor Documentation

◆ BaseContext()

pluginbase.Objects.Syncable.BaseContext.BaseContext	(	SyncableEndpoint	endpoint,
		IFrameTimeState	timeState
	)

protected

Creates an instance of the context

Parameters

endpoint	Endpoint.
timeState	Time state.

         {
             Endpoint = endpoint;
             TimeState = timeState;
         }

Member Function Documentation

◆ Fail()

void pluginbase.Objects.Syncable.BaseContext.Fail ( )

Failed a context

         {
             Failed = true;
         }

◆ Increment()

void pluginbase.Objects.Syncable.BaseContext.Increment ( )

Increment reads of a context

         {
             ReadCount++;
         }

◆ Reset()

void pluginbase.Objects.Syncable.BaseContext.Reset ( )

Reset this instance to make it reusable

         {
             ReadCount = 0;
             Failed = false;
         }

Member Data Documentation

◆ Endpoint

readonly SyncableEndpoint pluginbase.Objects.Syncable.BaseContext.Endpoint

The mode in which to decode content

◆ SIMULATE_FREQUENCY_PER_SECOND

const int pluginbase.Objects.Syncable.BaseContext.SIMULATE_FREQUENCY_PER_SECOND = 15

protected

The default frequency per-second

◆ TimeState

readonly IFrameTimeState pluginbase.Objects.Syncable.BaseContext.TimeState

The time state of this frame

Property Documentation

◆ EmptyOrFailed

bool pluginbase.Objects.Syncable.BaseContext.EmptyOrFailed

get

Are we empty or a failure?

true if valid not empty; otherwise, false.

◆ Failed

bool pluginbase.Objects.Syncable.BaseContext.Failed

get

Gets a value indicating whether this pluginbase.Objects.Syncable.DecodeContext is failed.

true if failed; otherwise, false.

◆ ReadCount

int pluginbase.Objects.Syncable.BaseContext.ReadCount

get

How many reads ocurred in this context

The read count.

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

pluginbase/Objects/Syncable/BaseContext.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties