close

The close method closes the BarrageSession.

Note

A BarrageSession created by barrage_session owns its gRPC channel, so close shuts down the channel as well. If closing the session or shutting down the channel throws an exception, close raises a DHError. close waits up to 10 seconds for the channel to terminate.

BarrageSession is also a context manager: a with block closes the session when it exits.

Syntax

close()

Parameters

This method does not take any parameters.

Returns

None.

Examples

The following examples use anonymous authentication, so the target server must allow it (-DAuthHandlers=io.deephaven.auth.AnonymousAuthenticationHandler). For a server that requires credentials, pass auth_type and auth_token to barrage_session and to Session.

from deephaven.barrage import barrage_session

barrage_sesh = barrage_session("localhost", 10000)

barrage_sesh.close()

The following example uses a with block to close both the publishing client session and the Barrage session automatically:

from deephaven.barrage import barrage_session
from pydeephaven import Session
from pydeephaven.ticket import SharedTicket

# Both sessions close when their with blocks exit; the snapshot is a static local copy
with Session(host="localhost", port=10000) as client_session:
    # Publish a table to a shared ticket with the Python client
    client_table = client_session.empty_table(10).update(["X = i"])
    ticket = SharedTicket.random_ticket()
    client_session.publish_table(ticket, client_table)

    with barrage_session("localhost", 10000) as barrage_sesh:
        local_table = barrage_sesh.snapshot(ticket.bytes)

close

Syntax

Parameters

Returns

Examples

Related documentation