StreamBase Class Reference

Base class for a stream. More...

#include <cvb/gevserver/stream.hpp>

Inherited by Stream, and StreamGev3.

Public Member Functions
virtual bool	IsRunning () const
	Gets whether this stream is running.
virtual std::int64_t	ResendBuffersCount () const
	Gets the number of resend buffers.
virtual void	SetResendBuffersCount (const std::int64_t &numBuffers)
	Sets the number of resend buffers.

Protected Member Functions
	StreamBase (const ServerBasePtr &parent)
	Creates the stream from the given parent server.

Detailed Description

Base class for a stream.

Constructor & Destructor Documentation

StreamBase()

StreamBase ( const ServerBasePtr & parent )

inlineexplicitprotected

Creates the stream from the given parent server.

Parameters

parent

Parent server object.

Member Function Documentation

IsRunning()

bool IsRunning ( ) const

inlinevirtual

Gets whether this stream is running.

Streaming can only be enabled by the remote client. Send is only possible as long as the stream is active (running).

Note that acquisition start/stop is an asynchronous action without any means to synchronize. Use the TrySend methods to avoid exceptions.

true if Parent's GevServer::State is State::AcquisitionEnabled; false otherwise.

ResendBuffersCount()

std::int64_t ResendBuffersCount ( ) const

inlinevirtual

Gets the number of resend buffers.

This number specifies for how many full frames a packet resend can be done; set to 0 if no packet resend is to be supported.

SetResendBuffersCount()

void SetResendBuffersCount ( const std::int64_t & numBuffers )

inlinevirtual

Sets the number of resend buffers.

This number specifies for how many full frames a packet resend can be done; set to 0 if no packet resend is to be supported.

This property can only be change if the parent is in State::Configuration GevServer::State.