View Source FLHook.Client (FLHook Client v2.1.1)

A client to connect to a FLHook socket.

Summary

Types

Type representing a FLHook client process.

Functions

The child specification for a FLHook client.

Closes the connection.

Indicates whether the socket is connected.

Opens the connection.

Starts the FLHook client using the given config or options.

Starts the FLHook client using the given config and options.

Types

@type client() :: GenServer.server()

Type representing a FLHook client process.

Functions

@spec child_spec(term()) :: Supervisor.child_spec()

The child specification for a FLHook client.

@spec close(client()) :: :ok

Closes the connection.

@spec connected?(client()) :: boolean()

Indicates whether the socket is connected.

@spec open(client()) :: :ok | {:error, Exception.t()}

Opens the connection.

@spec start_link(FLHook.Config.t() | Keyword.t()) :: GenServer.on_start()

Starts the FLHook client using the given config or options.

Link to this function

start_link(config, opts)

View Source

Starts the FLHook client using the given config and options.