Server Class Reference

Specialized server class for GigE Vision servers version before 3. More...

#include <decl_server.hpp>

Inherits ServerBase.

Public Member Functions
void *	Handle () const noexcept override
	Returns the internal handle of this server object.
Public Member Functions inherited from ServerBase
virtual GevServer::State	State ()
	Gets the the current state this server is in.
virtual GevServer::DriverType	DriverType ()
	Gets the GigE Vision driver used by this server object.
virtual String	UserVersion () const
	Gets the user defined version that is appended to the device version.
virtual void	SetUserVersion (const String &value)
	Sets the user defined version that is appended to the device version.
virtual Cvb::NetworkConnection	LocalEndpoint () const
	Gets the local end point this server is bound to.
virtual Cvb::NetworkConnection	RemoteEndpoint () const
	Gets the remote end point this server is connected to.
virtual NodeMapPtr	NodeMap () const
	Returns the GenApi node map of this server.
virtual void	Start (const Cvb::NetworkConnection::IPAddress &address)
	Starts this server and binds it to the given address .
virtual void	Start (const Cvb::NetworkConnection::IPAddressUInt &address)
	Starts this server and binds it to the given address .
virtual void	Stop ()
	Stops this server.

Static Public Member Functions
static ServerPtr	CreateNonStreaming ()
	Creates a non-streaming GigE Vision server object.
static ServerPtr	CreateWithConstSize (Size2D< int > size, PfncFormat pixelFormat, GevServer::DriverType driverType=GevServer::DriverType::Auto)
	Creates a new Server object with a constant width and height.
static ServerPtr	CreateWithConstSize (Size2D< int > size, ColorModel colorModel, DataType dataType, GevServer::DriverType driverType=GevServer::DriverType::Auto)
	Creates a new Server object with a constant width and height.
static ServerPtr	CreateWithVariableSize (Size2D< int > maxSize, ColorModel colorModel, DataType dataType, GevServer::DriverType driverType=GevServer::DriverType::Auto)
	Creates a new Server object with a client configurable width, height and offsets.
static ServerPtr	CreateWithVariableSize (Size2D< int > maxSize, PfncFormat pixelFormat, GevServer::DriverType driverType=GevServer::DriverType::Auto)
	Creates a new Server object with a client configurable width, height and offsets.

Detailed Description

Specialized server class for GigE Vision servers version before 3.

Member Function Documentation

CreateNonStreaming()

ServerPtr CreateNonStreaming ( )

inlinestatic

Creates a non-streaming GigE Vision server object.

For stream-capable variants see CreateWithConstSize(Size2D, ColorModel, DataType, DriverType) or CreateWithVariableSize(Size2D, ColorModel, DataType, DriverType).

You can use this server for pure communication use cases via the GenApi (think e.g. of a lighting controller or motor lens).

CreateWithConstSize() [1/2]

ServerPtr CreateWithConstSize ( Size2D< int > size, ColorModel colorModel, DataType dataType, GevServer::DriverType driverType = GevServer::DriverType::Auto )

inlinestatic

Creates a new Server object with a constant width and height.

Tries to map the given colorModel and dataType to a PfncFormat.

If you wish to change the payload size (e.g. because you want to send chunk data), you can set it on the "PayloadSizeValue" node in State::Configuration State.

Parameters

size	Width and height in pixels.
colorModel	Color model of the image to send.
dataType	CVB data type of the image to send.
driverType	The DriverType to use.

Returns

Newly created server object in State::Configuration state.

CreateWithConstSize() [2/2]

ServerPtr CreateWithConstSize ( Size2D< int > size, PfncFormat pixelFormat, GevServer::DriverType driverType = GevServer::DriverType::Auto )

inlinestatic

Creates a new Server object with a constant width and height.

If you wish to change the payload size (e.g. because you want to send chunk data), you can set it on the "PayloadSizeValue" node in State::Configuration State.

Parameters

size	Width and height in pixels.
pixelFormat	GenICam PFNC format value.
driverType	The DriverType to use.

Returns

Newly created server object in State::Configuration state.

CreateWithVariableSize() [1/2]

ServerPtr CreateWithVariableSize ( Size2D< int > maxSize, ColorModel colorModel, DataType dataType, GevServer::DriverType driverType = GevServer::DriverType::Auto )

inlinestatic

Creates a new Server object with a client configurable width, height and offsets.

Tries to map the given colorModel and dataType to a PfncFormat.

If you wish to change the payload size (e.g. because you want to send chunk data), you can set it on the "PayloadSizeValue" node in State::Configuration State.

Parameters

maxSize	Maximal width and height in pixels.
colorModel	Color model of the image to send.
dataType	CVB data type of the image to send.
driverType	The DriverType to use.

Returns

Newly created server object in State::Configuration state.

CreateWithVariableSize() [2/2]

ServerPtr CreateWithVariableSize ( Size2D< int > maxSize, PfncFormat pixelFormat, GevServer::DriverType driverType = GevServer::DriverType::Auto )

inlinestatic

Creates a new Server object with a client configurable width, height and offsets.

If you wish to change the payload size (e.g. because you want to send chunk data), you can set it on the "PayloadSizeValue" node in State::Configuration State.

Parameters

maxSize	Maximal width and height in pixels.
pixelFormat	GenICam PFNC format value.
driverType	The DriverType to use.

Returns

Newly created server object in State::Configuration state.

Handle()

void * Handle ( ) const

inlineoverridevirtualnoexcept

Returns the internal handle of this server object.

Returns

Implements ServerBase.