Class Publisher

Index

Constructors

Methods

congestion_control delete 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:273

Methods

congestion_control

congestion_control(): CongestionControl
get Congestion Control for a Publisher

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

delete

delete(delete_options): void
executes delete on publisher
Parameters
- delete_options: PublisherDeleteOptions
Returns void
void
- Defined in src/pubsub.ts:381

encoding

encoding(): Encoding
get Encoding declared for Publisher

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

key_expr

key_expr(): KeyExpr
gets the Key Expression from Publisher

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

priority

priority(): Priority
get Priority declared for Publisher

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

put

put(payload, put_options?): void
Puts a payload on the publisher associated with this class instance
Parameters
- payload: IntoZBytes
- Optionalput_options: PublisherPutOptions
Returns void
void
- Defined in src/pubsub.ts:308

reliability

reliability(): Reliability
get Reliability declared for Publisher

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

undeclare

undeclare(): void
undeclares publisher

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