Skip to content

Latest commit

 

History

History
249 lines (109 loc) · 2.96 KB

tryorama.trycpclient.md

File metadata and controls

249 lines (109 loc) · 2.96 KB

Home > @holochain/tryorama > TryCpClient

TryCpClient class

A factory class to create client connections to a running TryCP server.

With a client, conductors on the server can ba configured, started and stopped. All valid Admin and App API commands can be sent to the server too.

Signature:

export declare class TryCpClient 

Properties

Property

Modifiers

Type

Description

bootstrapServerUrl

URL | undefined

conductors

TryCpConductor[]

signalingServerUrl

URL | undefined

Methods

Method

Modifiers

Description

addConductor(options)

Create and add a conductor to the client.

call(request)

Send a call to the TryCP server.

cleanAllConductors()

Run the reset command on the TryCP server to delete all conductor data.

cleanUp()

Shut down all registered conductors and delete them, and close the client connection.

close()

Closes the client connection.

create(serverUrl, timeout)

static

Create a client connection to a running TryCP server.

ping(data)

Send a ping with data.

setSignalHandler(port, signalHandler)

shutDownConductors()

Shut down all conductors on the connected TryCP server and disconnect their app interfaces.

unsetSignalHandler(port)