Deadline Class Reference

Expresses the maximum duration (deadline) within which an instance is expected to be updated. More...

Inherits IEquatable< Deadline >.

Public Member Functions
	Deadline (Duration period)
	Creates a new instance More...
Deadline	With (Action< DeadlineBuilder > build)
	Creates a new Deadline with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (Deadline other)
	Compares for equality More...

Properties
Duration	Period [get]
	Duration of the deadline period. More...
static Deadline	Default [get]
	Singleton containing the default value of a Deadline More...

Detailed Description

Expresses the maximum duration (deadline) within which an instance is expected to be updated.

Constructor & Destructor Documentation

Deadline()

Deadline

(

Duration

period

)

Creates a new instance

Parameters

period

The value for Period

Member Function Documentation

Equals() [1/2]

bool Equals

(

Deadline

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

Deadline With

(

Action< DeadlineBuilder >

build

)

Creates a new Deadline with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this Deadline.

Returns

A new Deadline with the changes applied by the Action

Property Documentation

Default

Deadline Default

staticget

Singleton containing the default value of a Deadline

Period

Duration Period

get

Duration of the deadline period.

The full documentation is available in the C API: DDS_DeadlineQosPolicy::period