carla::streaming::detail::Stream< StreamStateT > 模板类 参考

#include <Stream.h>

carla::streaming::detail::Stream< StreamStateT > 的协作图:

Public 成员函数
bool	AreClientsListening ()
Buffer	MakeBuffer ()
	Pull a buffer from the buffer pool associated to this stream.
template<typename T >
Stream &	operator<< (const T &data)
	Make a copy of data and flush it down the stream.
Stream &	operator= (const Stream &)=default
Stream &	operator= (Stream &&)=default
	Stream ()=delete
	Stream (const Stream &)=default
	Stream (Stream &&)=default
Token	token () const
	Token associated with this stream.
template<typename... Buffers>
void	Write (Buffers &&... buffers)
	Flush buffers down the stream. No copies are made.

Private 成员函数
	Stream (std::shared_ptr< StreamStateT > state)

Private 属性
std::shared_ptr< StreamStateT >	_shared_state

友元
class	detail::Dispatcher

详细描述

template<typename StreamStateT>
class carla::streaming::detail::Stream< StreamStateT >

在文件 detail/Stream.h 第 22 行定义.

构造及析构函数说明

Stream() [1/4]

template<typename StreamStateT >

carla::streaming::detail::Stream< StreamStateT >::Stream ( )

delete

Stream() [2/4]

template<typename StreamStateT >

carla::streaming::detail::Stream< StreamStateT >::Stream ( const Stream< StreamStateT > & )

default

Stream() [3/4]

template<typename StreamStateT >

carla::streaming::detail::Stream< StreamStateT >::Stream ( Stream< StreamStateT > && )

default

Stream() [4/4]

template<typename StreamStateT >

carla::streaming::detail::Stream< StreamStateT >::Stream ( std::shared_ptr< StreamStateT > state )

inlineprivate

在文件 detail/Stream.h 第 74 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::_shared_state , 以及 DEBUG_ASSERT.

成员函数说明

AreClientsListening()

template<typename StreamStateT >

bool carla::streaming::detail::Stream< StreamStateT >::AreClientsListening ( )

inline

在文件 detail/Stream.h 第 65 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::_shared_state.

MakeBuffer()

template<typename StreamStateT >

Buffer carla::streaming::detail::Stream< StreamStateT >::MakeBuffer ( )

inline

Pull a buffer from the buffer pool associated to this stream.

Discarded buffers are re-used to avoid memory allocations.

注解

Re-using buffers is optimized for the use case in which all the messages sent through the stream are big and have (approximately) the same size.

在文件 detail/Stream.h 第 45 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::_shared_state.

被这些函数引用 carla::streaming::detail::Stream< StreamStateT >::operator<<().

这是这个函数的调用关系图:

operator<<()

template<typename StreamStateT >

template<typename T >

Stream & carla::streaming::detail::Stream< StreamStateT >::operator<< ( const T & data )

inline

Make a copy of data and flush it down the stream.

在文件 detail/Stream.h 第 58 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::MakeBuffer() , 以及 carla::streaming::detail::Stream< StreamStateT >::Write().

函数调用图:

operator=() [1/2]

template<typename StreamStateT >

Stream & carla::streaming::detail::Stream< StreamStateT >::operator= ( const Stream< StreamStateT > & )

default

operator=() [2/2]

template<typename StreamStateT >

Stream & carla::streaming::detail::Stream< StreamStateT >::operator= ( Stream< StreamStateT > && )

default

token()

template<typename StreamStateT >

Token carla::streaming::detail::Stream< StreamStateT >::token ( ) const

inline

Token associated with this stream.

This token can be used by a client to subscribe to this stream.

在文件 detail/Stream.h 第 35 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::_shared_state.

被这些函数引用 Benchmark::AddStream() , 以及 FCarlaServer::FPimpl::BindActions().

这是这个函数的调用关系图:

Write()

template<typename StreamStateT >

template<typename... Buffers>

void carla::streaming::detail::Stream< StreamStateT >::Write ( Buffers &&... buffers )

inline

Flush buffers down the stream. No copies are made.

在文件 detail/Stream.h 第 52 行定义.

引用了 carla::streaming::detail::Stream< StreamStateT >::_shared_state.

被这些函数引用 carla::streaming::detail::Stream< StreamStateT >::operator<<().

这是这个函数的调用关系图:

友元及相关函数文档

detail::Dispatcher

template<typename StreamStateT >

friend class detail::Dispatcher

friend

在文件 detail/Stream.h 第 72 行定义.

类成员变量说明

_shared_state

template<typename StreamStateT >

std::shared_ptr<StreamStateT> carla::streaming::detail::Stream< StreamStateT >::_shared_state

private

在文件 detail/Stream.h 第 79 行定义.

被这些函数引用 carla::streaming::detail::Stream< StreamStateT >::AreClientsListening(), carla::streaming::detail::Stream< StreamStateT >::MakeBuffer(), carla::streaming::detail::Stream< StreamStateT >::Stream(), carla::streaming::detail::Stream< StreamStateT >::token() , 以及 carla::streaming::detail::Stream< StreamStateT >::Write().

---

该类的文档由以下文件生成:

• detail/Stream.h