# smpl

<a id="smpl"></a>

# smpl

Symple protocol messages, peers, client, and server helpers.

## Classes

| Name | Description |
|------|-------------|
| [`Client`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Client.md#client-7) | Symple v4 client. |
| [`Command`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Command.md#command) | Symple command message with a node path and action verb. |
| [`Event`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Event.md#event-2) | Symple event message carrying a named occurrence with a timestamp. |
| [`Form`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Form.md#form) | Interactive form with pages, sections, and fields for command data exchange. |
| [`FormElement`](https://auscaster.com/icey/docs/api-reference/icy-smpl-FormElement.md#formelement) | Base element within a Symple form. |
| [`FormField`](https://auscaster.com/icey/docs/api-reference/icy-smpl-FormField.md#formfield) | [Form](https://auscaster.com/icey/docs/api-reference/icy-smpl-Form.md#form) input field with typed values and selectable options. |
| [`Message`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Message.md#message-12) | Base Symple protocol message with addressing, status, data, and notes. |
| [`Peer`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Peer.md#peer-1) | Symple peer record containing identity, presence, and custom fields. |
| [`Presence`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Presence.md#presence) | Symple presence message indicating a peer's online status. |
| [`Roster`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Roster.md#roster-2) | The [Roster](https://auscaster.com/icey/docs/api-reference/icy-smpl-Roster.md#roster-2) provides a registry for active network peers indexed by session ID. |
| [`Server`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Server.md#server-12) | Symple v4 server. |
| [`ServerPeer`](https://auscaster.com/icey/docs/api-reference/icy-smpl-ServerPeer.md#serverpeer) | Per-connection state for a connected Symple peer. |
| [`Address`](https://auscaster.com/icey/docs/api-reference/icy-smpl-Address.md#address-13) | The [Address](https://auscaster.com/icey/docs/api-reference/icy-smpl-Address.md#address-13) structure is an endpoint identifier for a peer on the network. The format is like so: user\|id |
| [`ClientState`](https://auscaster.com/icey/docs/api-reference/icy-smpl-ClientState.md#clientstate-1) | [Client](https://auscaster.com/icey/docs/api-reference/icy-smpl-Client.md#client-7) connection states. |
