Class Session

Zenoh Session

Index

Methods

close

close(): Promise<void>
Closes a session, cleaning up the resource in Zenoh

Returns Promise<void>
Nothing
- Defined in src/session.ts:209

declare_keyexpr

declare_keyexpr(key_expr): KeyExpr
Creates a Key Expression
Parameters
- key_expr: IntoKeyExpr
Returns KeyExpr
KeyExpr
- Defined in src/session.ts:269

declare_publisher

declare_publisher(keyexpr, publisher_opts): Publisher
Declares a new Publisher
Parameters
- keyexpr: IntoKeyExpr
  string of key_expression
- publisher_opts: PublisherOptions
  Optional, set of options to be used when declaring a publisher
Returns Publisher
Publisher

Remarks
If a Queryable is created with a callback, it cannot be simultaneously polled for new Query's
- Defined in src/session.ts:579

declare_querier

declare_querier(into_keyexpr, querier_opts): Querier
Declares a Querier
Parameters
- into_keyexpr: IntoKeyExpr
- querier_opts: QuerierOptions
Returns Querier
Publisher
- Defined in src/session.ts:642

declare_queryable

declare_queryable(key_expr, queryable_opts?): Queryable
Declares a new Queryable
Parameters
- key_expr: IntoKeyExpr
  string of key_expression
- Optionalqueryable_opts: QueryableOptions
  Optional additional settings for a Queryable [QueryableOptions]
Returns Queryable
Queryable

Remarks
If a Queryable is created with a callback, it cannot be simultaneously polled for new Query's
- Defined in src/session.ts:515

declare_subscriber

declare_subscriber(key_expr, subscriber_opts?): Subscriber
Declares a new subscriber
Parameters
- key_expr: IntoKeyExpr
  string of key_expression
- Optionalsubscriber_opts: SubscriberOptions
  Options for the subscriber, including a handler
Returns Subscriber
Subscriber

Remarks
If a Subscriber is created with a callback, it cannot be simultaneously polled for new values
- Defined in src/session.ts:438

delete

delete(into_key_expr, delete_opts?): void
Executes a Delete on a session, for a specific key expression KeyExpr
Parameters
- into_key_expr: IntoKeyExpr
  something that implements intoKeyExpr
- Optionaldelete_opts: DeleteOpts
  optional additional parameters to go with a delete function
Returns void
void
- Defined in src/session.ts:298

dispose

dispose(): void
Returns void
- Defined in src/session.ts:178

get

get(into_selector, get_options?): undefined | Receiver
Issues a get query on a Zenoh session
Parameters
- into_selector: IntoSelector
  representing a KeyExpr and Parameters
- Optionalget_options: GetOptions
Returns undefined | Receiver
Receiver
- Defined in src/session.ts:334

info

info(): Promise<SessionInfo>
Returns the Zenoh SessionInfo Object

Returns Promise<SessionInfo>
SessionInfo
- Defined in src/session.ts:278

is_closed

is_closed(): boolean
Returns boolean
- Defined in src/session.ts:214

liveliness

liveliness(): Liveliness
Obtain a Liveliness struct tied to this Zenoh Session.

Returns Liveliness
Liveliness
- Defined in src/session.ts:488

new_timestamp

new_timestamp(): Promise<Timestamp>
Creates a new Timestamp instance

Returns Promise<Timestamp>
Timestamp
- Defined in src/session.ts:497

put

put(into_key_expr, into_zbytes, put_opts?): void
Puts a value on the session, on a specific key expression KeyExpr
Parameters
- into_key_expr: IntoKeyExpr
  something that implements intoKeyExpr
- into_zbytes: IntoZBytes
  something that implements intoValue
- Optionalput_opts: PutOptions
  an interface for the options settings on puts
Returns void
void
- Defined in src/session.ts:225

`Static`open

open(config): Promise<Session>
Creates a new Session instance
Parameters
- config: Config
  Config for session
Returns Promise<Session>
Typescript instance of a Session

Remarks
Opens A Zenoh Session
- Defined in src/session.ts:199