RtspServerHandle Class

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

Declaration

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

Included Headers

#include <Session.h>

Friends Index

class	Session

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 Session running in RTSP server mode.

Returned by Session::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 Session 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

Session::run_rtsp

Definition at line 74 of file Session.h.

Friends

Session

friend class Session

Definition at line 101 of file Session.h.

101 friend class Session;

Public Constructors

RtspServerHandle()

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

default

Default-construct an empty handle that owns no server.

Definition at line 77 of file Session.h.

RtspServerHandle()

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

delete

Non-copyable: server ownership is unique.

Definition at line 81 of file Session.h.

RtspServerHandle()

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

noexcept

Move-constructible.

Definition at line 84 of file Session.h.

Public Destructor

~RtspServerHandle()

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

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

Definition at line 79 of file Session.h.

Public Operators

operator=()

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

delete

Non-copyable.

Definition at line 82 of file Session.h.

operator=()

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

noexcept

Move-assignable.

Definition at line 85 of file Session.h.

Public Member Functions

kill()

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

inline

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

Definition at line 94 of file Session.h.

94 void kill() {

95 stop();

96 }

running()

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

Returns true while the server is actively serving clients.

Definition at line 98 of file Session.h.

stop()

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

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

Definition at line 92 of file Session.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 88 of file Session.h.

88 const std::string& url() const {

89 return url_;

90 }

Private Member Attributes

guard_

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

Definition at line 105 of file Session.h.

105 std::shared_ptr<void> guard_;

impl_

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

Definition at line 104 of file Session.h.

104 void* impl_ = nullptr;

url_

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

Definition at line 103 of file Session.h.

103 std::string url_;

---

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

• Session.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.