The stream to send Images or other data. More...
#include <cvb/gevserver/stream.hpp>
Inherits StreamBase, and enable_shared_from_this< Stream >.
Public Member Functions | |
Stream (const ServerBasePtr &parent) | |
Creates the stream from the given parent server. | |
void | Send (const ImagePtr &image, std::function< void(const ImagePtr &)> imageReleased) |
Sends the given image to the remote client. | |
bool | TrySend (const ImagePtr &image, std::function< void(const ImagePtr &)> imageReleased) |
Tries to send the given image to the remote client. | |
void | Send (const Image &image) |
Sends the given image to the remote client. | |
bool | TrySend (const Image &image) |
Tries to sends the given image to the remote client. | |
void | Send (const ImageBufferDescription &bufferDescription, void *basePtr, const std::size_t &bufferSize, std::function< void(void *)> bufferReleased) |
Sends the image at the given basePtr . | |
bool | TrySend (const ImageBufferDescription &bufferDescription, void *basePtr, const std::size_t &bufferSize, std::function< void(void *)> bufferReleased) |
Tries to send the image at the given basePtr . | |
![]() | |
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. | |
Additional Inherited Members | |
![]() | |
StreamBase (const ServerBasePtr &parent) | |
Creates the stream from the given parent server. | |
The stream to send Images or other data.
|
inlineexplicit |
Creates the stream from the given parent server.
parent | Parent server object. |
|
inline |
Sends the given image to the remote client.
The given image must fit into the payload size set at creation/State::Configuration state.
Packet resend must be disabled (ResendBuffersCount is zero).
image | Image to be sent. |
The image will be copied to the resend buffer.
|
inline |
Sends the image at the given basePtr .
The given image buffer must fit into the payload size set at creation/GevServerState::Configuration state.
If packet resend is enabled (ResendBuffersCount larger than zero), then the given image buffer must remain unchanged until bufferReleased has been called! In case packet resend is disabled bufferReleased will be called immediately.
bufferDescription | Description of the image at basePtr . |
basePtr | Address of the image buffer to send. |
bufferSize | Length in bytes of the buffer at basePtr . |
bufferReleased | Mandatory delegate to be called when the given image buffer is not needed anymore for packet resend. |
|
inline |
Sends the given image to the remote client.
The given image must fit into the payload size set at creation/GevServerState.Configuration state.
If packet resend is enabled (ResendBuffersCount larger than zero), then the given image must remain unchanged until imageReleased has been called! In case packet resend is disabled imageReleased will be called immediately.
image | Image to be sent. |
imageReleased | Delegate to be called when the given image is not needed anymore for packet resend. If null the image will be copied to the resend buffer. |
|
inline |
Tries to sends the given image to the remote client.
The given image must fit into the payload size set at creation/State::Configuration state.
Packet resend must be disabled (ResendBuffersCount is zero).
image | Image to be sent. |
The image will be copied to the resend buffer.
|
inline |
Tries to send the image at the given basePtr .
bufferDescription | Description of the image at basePtr . |
basePtr | Address of the image buffer to send. |
bufferSize | Length in bytes of the buffer at basePtr . |
bufferReleased | Delegate to be called when the given image buffer is not needed anymore for packet resend. |
|
inline |
Tries to send the given image to the remote client.
The given image must fit into the payload size set at creation/GevServerState::Configuration state.
If packet resend is enabled (ResendBuffersCount larger than zero), then the given image must remain unchanged until imageReleased has been called! In case packet resend is disabled imageReleased will be called immediately.
image | Image to be sent. |
imageReleased | Delegate to be called when the given image is not needed anymore for packet resend. If null the image will be copied to the resend buffer. |