Describes a Channel that messages are written to. A Channel represents a single connection from a publisher to a topic, so each topic will have one Channel per publisher. Channels optionally reference a Schema, for message encodings that are not self-describing (e.g. JSON) or when schema information is available (e.g. JSONSchema). More...

#include <types.hpp>

Public Member Functions
	Channel ()=default

	Channel (const std::string_view topic, const std::string_view messageEncoding, SchemaId schemaId, const KeyValueMap &metadata={})

Public Attributes
ChannelId	id

std::string	messageEncoding

KeyValueMap	metadata

SchemaId	schemaId

std::string	topic

Detailed Description

Describes a Channel that messages are written to. A Channel represents a single connection from a publisher to a topic, so each topic will have one Channel per publisher. Channels optionally reference a Schema, for message encodings that are not self-describing (e.g. JSON) or when schema information is available (e.g. JSONSchema).

Definition at line 158 of file types.hpp.

Constructor & Destructor Documentation

◆ Channel() [1/2]

mcap::Channel::Channel ( )

default

◆ Channel() [2/2]

mcap::Channel::Channel	(	const std::string_view	topic,
		const std::string_view	messageEncoding,
		SchemaId	schemaId,
		const KeyValueMap &	metadata = `{}`
	)

inline

Definition at line 167 of file types.hpp.

Member Data Documentation

◆ id

ChannelId mcap::Channel::id

Definition at line 159 of file types.hpp.

◆ messageEncoding

std::string mcap::Channel::messageEncoding

Definition at line 161 of file types.hpp.

◆ metadata

KeyValueMap mcap::Channel::metadata

Definition at line 163 of file types.hpp.

◆ schemaId

SchemaId mcap::Channel::schemaId

Definition at line 162 of file types.hpp.

◆ topic

std::string mcap::Channel::topic

Definition at line 160 of file types.hpp.

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

types.hpp

Public Member Functions

Public Attributes