Relay.Client

Relay.Client

Relay.Client is the basic connection to RELAY, allowing you send commands to RELAY and setup handlers for inbound events.

Constructor

Constructs a client object to interact with RELAY.

Parameters

Examples

Create a Client to interact with the RELAY API:

1
from signalwire.relay.client import Client
2
3
client = Client(project='<project-id>', token='<project-token>')

Properties

Methods

connect

Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established.

Returns

None

Examples

1
# Make sure you have attached the listeners you need before connecting the client, or you might miss some events.
2
client.connect()

disconnect

Coroutine that close the RELAY connection, cancel the pending tasks and stop the event loop.

Returns

awaitable - A coroutine object.

Examples

Within an async function:

1
import asyncio
2
3
# with a 'client' variable already created..
4
async def sleep_and_disconnect():
5
  await asyncio.sleep(5)
6
  await client.disconnect()
7
  print('Client disconnected!')
8
9
asyncio.run(sleep_and_disconnect())

Scheduling a new asyncio task:

1
import asyncio
2
3
# schedule a task to disconnect the client..
4
asyncio.create_task(client.disconnect())

on

Attach an event handler for a specific type of event. The handler could be a coroutine or a normal function.

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the ready event:

1
def do_something(client):
2
  pass
3
4
client.on('ready', do_something)

off

Remove an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the ready event and then, remove the handler:

1
def do_something(client):
2
  pass
3
4
client.on('ready', do_something)
5
6
# .. later
7
client.off('ready', do_something)

Events

All available events you can attach a listener on.