Class Publisher

Index

Constructors

Methods

congestion_control encoding key_expr priority put reliability undeclare

Constructors

constructor

new Publisher(remote_publisher, key_expr, congestion_control, priority, reliability, encoding): Publisher
Creates a new Publisher on a session Note: this should never be called directly by the user. please use declare_publisher on a session.
Parameters
- remote_publisher: RemotePublisher
  A Session to create the publisher on
- key_expr: KeyExpr
  A Key Expression
- congestion_control: CongestionControl
  Congestion control
- priority: Priority
  Priority for Zenoh Data
- reliability: Reliability
  Reliability for publishing data
- encoding: Encoding
Returns Publisher
a new instance of a publisher
- Defined in src/pubsub.ts:207

Methods

congestion_control

congestion_control(): CongestionControl
get Congestion Control for a Publisher

Returns CongestionControl
- Defined in src/pubsub.ts:301

encoding

encoding(): Encoding
get Encoding declared for Publisher

Returns Encoding
- Defined in src/pubsub.ts:274

key_expr

key_expr(): KeyExpr
gets the Key Expression from Publisher

Returns KeyExpr
instance
- Defined in src/pubsub.ts:230

priority

priority(): Priority
get Priority declared for Publisher

Returns Priority
- Defined in src/pubsub.ts:283

put

put(payload, encoding?, attachment?): void
Puts a payload on the publisher associated with this class instance
Parameters
- payload: IntoZBytes
  user payload, type that can be converted into a ZBytes
- Optionalencoding: IntoEncoding
  Encoding parameter for Zenoh data
- Optionalattachment: IntoZBytes
  optional extra data to send with Payload
Returns void
void
- Defined in src/pubsub.ts:243

reliability

reliability(): Reliability
get Reliability declared for Publisher

Returns Reliability
- Defined in src/pubsub.ts:292

undeclare

undeclare(): void
undeclares publisher

Returns void
void
- Defined in src/pubsub.ts:310