EtherCAT.Session (ethercat v0.5.0)

Copy Markdown View Source

Opaque identity for one started EtherCAT session.

A session is bound to both the master process and one generation of that process. It is the required capability for runtime, provisioning, diagnostics, signal subscription, and live capture operations.

Once stopped or replaced, operations made with the old session return {:error, :stale_session} rather than targeting a replacement session.

Summary

Functions

Return the currently active session identity for explicit host tooling.

Types

t()

@opaque t()

Functions

current()

@spec current() :: {:ok, t()} | {:error, term()}

Return the currently active session identity for explicit host tooling.