Class Session

Zenoh Session

Methods

close declare_publisher declare_querier declare_queryable declare_subscriber delete dispose get info liveliness put open

Methods

close

  • close(): Promise<void>

  • Closes a session, cleaning up the resource in Zenoh

    Returns Promise<void>

    Nothing

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

declare_querier

declare_queryable

  • declare_queryable(key_expr, queryable_opts?): Promise<Queryable>

  • Declares a new Queryable

    Parameters

    • key_expr: IntoKeyExpr

      string of key_expression

    • Optionalqueryable_opts: QueryableOptions

      Optional additional settings for a Queryable [QueryableOptions]

    Returns Promise<Queryable>

    Queryable

    Remarks

    If a Queryable is created with a callback, it cannot be simultaneously polled for new Query's

declare_subscriber

  • declare_subscriber(key_expr, handler?): Promise<Subscriber>

  • Declares a new subscriber

    Parameters

    • key_expr: IntoKeyExpr

      string of key_expression

    • handler: Handler | ((sample: Sample) => Promise<void>) = ...

      Either a HandlerChannel or a Callback Function to be called for all samples

    Returns Promise<Subscriber>

    Subscriber

    Remarks

    If a Subscriber is created with a callback, it cannot be simultaneously polled for new values

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

dispose

get

  • get(into_selector, handler?, get_options?): Promise<undefined | Receiver>

  • Issues a get query on a Zenoh session

    Parameters

    • into_selector: IntoSelector

      representing a KeyExpr and Parameters

    • handler: Handler | ((sample: Reply) => Promise<void>) = ...
    • Optionalget_options: GetOptions

    Returns Promise<undefined | Receiver>

    Receiver

info

liveliness

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

Staticopen

  • 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

Settings

Member Visibility

On This Page

Methods