Base data transport class for pipes. More...

#include <pipe.h>

Inheritance diagram for eq::fabric::Pipe< N, P, W, V >:

Collaboration diagram for eq::fabric::Pipe< N, P, W, V >:

Classes
struct	BackupData
Public Member Functions
Data Access
N *	getNode ()
const N *	getNode () const
const Windows &	getWindows () const
uint32_t	getPort () const
	Returns the port number of this pipe.
EQFABRIC_INL void	setPort (const uint32_t port)
uint32_t	getDevice () const
	Returns the device number of this pipe.
EQFABRIC_INL void	setDevice (const uint32_t device)
const PixelViewport &	getPixelViewport () const
EQFABRIC_INL void	setPixelViewport (const PixelViewport &pvp)
	Set the pipe's pixel viewport.
void	notifyPixelViewportChanged ()
EQFABRIC_INL PipePath	getPath () const
EQFABRIC_INL VisitorResult	accept (V &visitor)
	Traverse this pipe and all children using a pipe visitor.
EQFABRIC_INL VisitorResult	accept (V &visitor) const
	Const-version of accept().
internal
virtual EQFABRIC_INL void	backup ()
virtual EQFABRIC_INL void	restore ()
void	create (W **window)
void	release (W *window)
virtual void	output (std::ostream &) const
virtual EQFABRIC_INL uint128_t	commit (const uint32_t incarnation=CO_COMMIT_NEXT)
	Commit a new version of this object.
Public Types
typedef std::vector< W * >	Windows
	A vector of pointers to windows.
Protected Member Functions
	Pipe (N *parent)
virtual void	attach (const co::base::UUID &id, const uint32_t instanceID)
virtual EQFABRIC_INL void	serialize (co::DataOStream &os, const uint64_t dirtyBits)
	Worker for pack() and getInstanceData().
virtual EQFABRIC_INL void	deserialize (co::DataIStream &is, const uint64_t dirtyBits)
	Worker for unpack() and applyInstanceData().
virtual EQFABRIC_INL void	notifyDetach ()
	Notify that this object will be deregistered or unmapped.
virtual EQFABRIC_INL void	setDirty (const uint64_t bits)
	Add dirty flags to mark data for distribution.
virtual ChangeType	getChangeType () const
W *	_findWindow (const co::base::UUID &id)
virtual uint64_t	getRedistributableBits () const
Protected Types
enum	DirtyBits { DIRTY_ATTRIBUTES = Object::DIRTY_CUSTOM << 0, DIRTY_WINDOWS = Object::DIRTY_CUSTOM << 1, DIRTY_PIXELVIEWPORT = Object::DIRTY_CUSTOM << 2, DIRTY_MEMBER = Object::DIRTY_CUSTOM << 3, DIRTY_PIPE_BITS }
	The changed parts of the object since the last pack(). More...
Friends
class	Window
Attributes
enum	IAttribute { IATTR_HINT_THREAD, IATTR_HINT_AFFINITY, IATTR_HINT_CUDA_GL_INTEROP, IATTR_LAST, IATTR_ALL = IATTR_LAST + 5 }
	Pipe attributes. More...
EQFABRIC_INL void	setIAttribute (const IAttribute attr, const int32_t value)
int32_t	getIAttribute (const IAttribute attr) const
bool	isThreaded () const
static EQFABRIC_INL const std::string &	getIAttributeString (const IAttribute attr)

Detailed Description

template<class N, class P, class W, class V>
class eq::fabric::Pipe< N, P, W, V >

Base data transport class for pipes.

See also:: eq::Pipe

Definition at line 34 of file include/eq/fabric/pipe.h.

Member Typedef Documentation

template<class N, class P, class W, class V>

typedef std::vector< W* > eq::fabric::Pipe< N, P, W, V >::Windows

A vector of pointers to windows.

Version:: 1.0

Definition at line 38 of file include/eq/fabric/pipe.h.

Member Enumeration Documentation

template<class N, class P, class W, class V>

enum eq::fabric::Pipe::DirtyBits [protected]

The changed parts of the object since the last pack().

Subclasses should define their own bits, starting at DIRTY_CUSTOM.

Reimplemented from eq::fabric::Object.

Definition at line 181 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

enum eq::fabric::Pipe::IAttribute

Pipe attributes.

Version:: 1.0

Enumerator:

IATTR_HINT_THREAD	Execute tasks in separate thread (default)
IATTR_HINT_AFFINITY	Bind render thread to subset of cores.
IATTR_HINT_CUDA_GL_INTEROP	Configure CUDA context.

Definition at line 116 of file include/eq/fabric/pipe.h.

Member Function Documentation

template<class N, class P, class W, class V>

EQFABRIC_INL VisitorResult eq::fabric::Pipe< N, P, W, V >::accept ( V & visitor )

Traverse this pipe and all children using a pipe visitor.

Parameters:

visitor the visitor.

Returns:: the result of the visitor traversal.

Version:: 1.0

template<class N, class P, class W, class V>

EQFABRIC_INL VisitorResult eq::fabric::Pipe< N, P, W, V >::accept ( V & visitor ) const

Const-version of accept().

Version:: 1.0

template<class N, class P, class W, class V>

virtual EQFABRIC_INL uint128_t eq::fabric::Pipe< N, P, W, V >::commit ( const uint32_t incarnation = CO_COMMIT_NEXT ) [virtual]

Commit a new version of this object.

Objects using the change type STATIC can not be committed.

Master instances will increment new versions continously, starting at VERSION_FIRST. If the object has not changed, no new version will be generated, that is, the current version is returned. The high value of the returned version will always be 0.

Slave objects can be commited, but have certain caveats for serialization. Please refer to the Programming Guide for more details. Slave object commits will return a random version on a successful commit, or VERSION_NONE if the object has not changed since the last commit. The high value of a successful commit will never be 0.

The incarnation count is meaningful for buffered master objects. The commit implementation will keep all instance data committed with an incarnation count newer than current_incarnation - getAutoObsolete(). By default, each call to commit creates a new incarnation, retaining the data from last getAutoObsolete() commit calls. When the application wishes to auto obsolete by another metric than commit calls, it has to consistently provide an incarnation counter. Buffers with a higher incarnation count than the current are discarded. A typical use case is to tie the auto obsoletion to an application-specific frame loop. Decreasing the incarnation counter will lead to undefined results.

Parameters:

incarnation the commit incarnation for auto obsoletion.

Returns:: the new head version.

Reimplemented from eq::fabric::Object.

template<class N, class P, class W, class V>

virtual EQFABRIC_INL void eq::fabric::Pipe< N, P, W, V >::deserialize	(	co::DataIStream &	,
		const uint64_t
	)		`[protected, virtual]`

Worker for unpack() and applyInstanceData().

This function is called with the dirty bits send by the master instance. The dirty bits are received beforehand, and do not need to be deserialized by the overriding method.

See also:: serialize()

Version:: 1.0

Reimplemented from eq::fabric::Object.

template<class N, class P, class W, class V>

virtual ChangeType eq::fabric::Pipe< N, P, W, V >::getChangeType ( ) const [inline, protected, virtual]

Returns:: how the changes are to be handled.

Reimplemented from co::Serializable.

Definition at line 177 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

uint32_t eq::fabric::Pipe< N, P, W, V >::getDevice ( ) const [inline]

Returns the device number of this pipe.

The device number identifies the X screen for systems using the X11/GLX window system, or the number of the virtual screen for the AGL window system. On Windows systems it identifies the graphics adapter. Normally the device identifies a GPU.

Returns:: the device number of this pipe, or EQ_UNDEFINED_UINT32.

Version:: 1.0

Definition at line 76 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

int32_t eq::fabric::Pipe< N, P, W, V >::getIAttribute ( const IAttribute attr ) const [inline]

Returns:: the value of a pipe integer attribute.

Version:: 1.0

Definition at line 131 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

N* eq::fabric::Pipe< N, P, W, V >::getNode ( ) [inline]

Returns:: the parent node of this pipe.

Version:: 1.0

Definition at line 43 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

const N* eq::fabric::Pipe< N, P, W, V >::getNode ( ) const [inline]

Returns:: the parent node of this pipe.

Version:: 1.0

Definition at line 45 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

const PixelViewport& eq::fabric::Pipe< N, P, W, V >::getPixelViewport ( ) const [inline]

Returns:: the pixel viewport.

Version:: 1.0

Definition at line 81 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

uint32_t eq::fabric::Pipe< N, P, W, V >::getPort ( ) const [inline]

Returns the port number of this pipe.

The port number identifies the X server for systems using the X11/GLX window system, i.e., the :<port>.<screen> of the DISPLAY name. It currently has no meaning on all other systems.

Returns:: the port number of this pipe, or EQ_UNDEFINED_UINT32.

Version:: 1.0

Definition at line 61 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

const Windows& eq::fabric::Pipe< N, P, W, V >::getWindows ( ) const [inline]

Returns:: the vector of child windows.

Version:: 1.0

Definition at line 48 of file include/eq/fabric/pipe.h.

template<class N, class P, class W, class V>

virtual EQFABRIC_INL void eq::fabric::Pipe< N, P, W, V >::notifyDetach ( ) [protected, virtual]

Notify that this object will be deregistered or unmapped.

The method is called from the thread initiating the deregistration or unmapping, before the operation is executed.

See also:: isMaster()

Reimplemented from eq::fabric::Object.

template<class N, class P, class W, class V>

virtual EQFABRIC_INL void eq::fabric::Pipe< N, P, W, V >::serialize	(	co::DataOStream &	,
		const uint64_t
	)		`[protected, virtual]`

Worker for pack() and getInstanceData().

Override this and deserialize() if you want to distribute subclassed data.

This method is called with DIRTY_ALL from getInstanceData() and with the actual dirty bits from pack(), which also resets the dirty state afterwards. The dirty bits are transmitted beforehand, and do not need to be transmitted by the overriding method.

Version:: 1.0

Reimplemented from eq::fabric::Object.

template<class N, class P, class W, class V>

virtual EQFABRIC_INL void eq::fabric::Pipe< N, P, W, V >::setDirty ( const uint64_t bits ) [protected, virtual]

Add dirty flags to mark data for distribution.

Version:: 1.0

Reimplemented from co::Serializable.

Reimplemented in eq::Pipe.

template<class N, class P, class W, class V>

EQFABRIC_INL void eq::fabric::Pipe< N, P, W, V >::setPixelViewport ( const PixelViewport & pvp )

Set the pipe's pixel viewport.

If invalid, the OSPipe has to set it to the device viewport during configInit().

Parameters:

pvp	the viewport in pixels.

Version:: 1.0

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

include/eq/fabric/pipe.h

Classes

Public Member Functions

Public Types

Protected Member Functions

Protected Types

Friends

Attributes

Detailed Description

template<class N, class P, class W, class V> class eq::fabric::Pipe< N, P, W, V >

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

template<class N, class P, class W, class V>
class eq::fabric::Pipe< N, P, W, V >