RtspServerHandle Class

Live handle for a Graph running in RTSP server mode. More...

Declaration

class simaai::neat::RtspServerHandle { ... }

Included Headers

#include <Graph.h>

Friends Index

class	Graph

Public Constructors Index

	RtspServerHandle ()=default
	Default-construct an empty handle that owns no server. More...
	RtspServerHandle (const RtspServerHandle &)=delete
	Non-copyable: server ownership is unique. More...
	RtspServerHandle (RtspServerHandle &&) noexcept
	Move-constructible. More...

Public Destructor Index

	~RtspServerHandle ()
	Destructor; stops the server and tears down the underlying pipeline. More...

Public Operators Index

RtspServerHandle &	operator= (const RtspServerHandle &)=delete
	Non-copyable. More...
RtspServerHandle &	operator= (RtspServerHandle &&) noexcept
	Move-assignable. More...

Public Member Functions Index

const std::string &	url () const
	Returns the broadcast URL (e.g., "rtsp://0.0.0.0:8554/stream") clients connect to. More...
void	stop ()
	Stop the server and tear down the pipeline. Safe to call multiple times. More...
void	kill ()
	Alias for stop(). Kept for parity with other handle types. More...
bool	running () const
	Returns true while the server is actively serving clients. More...

Private Member Attributes Index

std::string	url_
void *	impl_ = nullptr
std::shared_ptr< void >	guard_

Description

Live handle for a Graph running in RTSP server mode.

Returned by Graph::run_rtsp(opts). The handle owns the running RTSP server background threads and the underlying GStreamer pipeline. Destroying the handle (or calling stop()) tears down the server cleanly. Move-only: the handle uniquely owns its server.

Use this when the Graph terminates in an H.264 encoded stream that should be published as an RTSP source for downstream consumers (VLC, ffmpeg, browsers via WebRTC gateway, etc.).

See Also

Graph::run_rtsp

Definition at line 94 of file Graph.h.

Friends

Graph

friend class Graph

Definition at line 121 of file Graph.h.

Public Constructors

RtspServerHandle()

simaai::neat::RtspServerHandle::RtspServerHandle ()

default

Default-construct an empty handle that owns no server.

Definition at line 97 of file Graph.h.

RtspServerHandle()

simaai::neat::RtspServerHandle::RtspServerHandle (const RtspServerHandle &)

delete

Non-copyable: server ownership is unique.

Definition at line 101 of file Graph.h.

RtspServerHandle()

simaai::neat::RtspServerHandle::RtspServerHandle (RtspServerHandle &&)

noexcept

Move-constructible.

Definition at line 104 of file Graph.h.

Public Destructor

~RtspServerHandle()

simaai::neat::RtspServerHandle::~RtspServerHandle ()

Destructor; stops the server and tears down the underlying pipeline.

Definition at line 99 of file Graph.h.

Public Operators

operator=()

RtspServerHandle & simaai::neat::RtspServerHandle::operator= (const RtspServerHandle &)

delete

Non-copyable.

Definition at line 102 of file Graph.h.

operator=()

RtspServerHandle & simaai::neat::RtspServerHandle::operator= (RtspServerHandle &&)

noexcept

Move-assignable.

Definition at line 105 of file Graph.h.

Public Member Functions

kill()

void simaai::neat::RtspServerHandle::kill ()

inline

Alias for stop(). Kept for parity with other handle types.

Definition at line 114 of file Graph.h.

running()

bool simaai::neat::RtspServerHandle::running ()

Returns true while the server is actively serving clients.

Definition at line 118 of file Graph.h.

stop()

void simaai::neat::RtspServerHandle::stop ()

Stop the server and tear down the pipeline. Safe to call multiple times.

Definition at line 112 of file Graph.h.

url()

const std::string & simaai::neat::RtspServerHandle::url ()

inline

Returns the broadcast URL (e.g., "rtsp://0.0.0.0:8554/stream") clients connect to.

Definition at line 108 of file Graph.h.

Private Member Attributes

guard_

std::shared_ptr<void> simaai::neat::RtspServerHandle::guard_

Definition at line 125 of file Graph.h.

impl_

void* simaai::neat::RtspServerHandle::impl_ = nullptr

Definition at line 124 of file Graph.h.

url_

std::string simaai::neat::RtspServerHandle::url_

Definition at line 123 of file Graph.h.

---

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

• Graph.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.