Scale Intelligence■ Docs
Docs / The model / LocalListener

LocalListener.

One listener of the local server on a person's machine: the Unix domain socket or named pipe by default, and the TCP and WebSocket listeners when turned on, every one bound to the loopback address and never to a network interface; a caller proves itself with the install token in its first message

Figure 1LocalListenerspecified
LOCALLISTENERdefinition at user scopekindenum:unix-socket|named-pipe|tcp|w…a path, or 127.0.0.1 with a port chosen at installaddresstextthe socket always; TCP and WebSocket by a setting of the appenabledboolkept in the operating system's keychaininstall_tokenVaultEntryalways true; a network interface fails the checkbound_to_loopback_onlyboolVAULTENTRYthrough install_token
LocalListener is a definition at user scope. The drawing shows its fields and the objects that they point at.
kind
definition
scope
user
key
the app’s install and the kind
store
postgres
family
network

Fields#

fieldtyperequirednote
kindone of unix-socket | named-pipe | tcp | websocketyes
addresstextyesa path, or 127.0.0.1 with a port chosen at install
enabledboolyesthe socket always; TCP and WebSocket by a setting of the app
install_tokenVaultEntryyeskept in the operating system’s keychain
bound_to_loopback_onlyboolyesalways true; a network interface fails the check

Routes that use it#

No route takes or returns LocalListener directly. The record holds it, and the objects that point at it reach it.