type

Conn

const class Conn : Actor

Conn models a connection to a single endpoint.

methods

close	Force close of connection if open
data	Library specific connector data.
db	Runtime database
dis	Display name
id	Record id
isDisabled	Does the record have the `disabled` marker configured
lib	Parent connector library
linger	Configured linger timeout - see `connLinger`
log	Log for this connector
openRetryFreq	Frequency to retry opens.
ping	Invoke ping request
pingFreq	Configured ping frequency to test connection or null if feature is disabled - see `connPingFreq`
point	Get the point managed by this connector via its point rec id.
pointIds	Get list of all point ids managed by this connector.
points	Get list of all points managed by this connector.
pollFreq	Configured poll frequency if connector uses manual polling
pollMode	Poll strategy for connector
rec	Current version of the record.
receive	Actor messages are routed to `ConnDispatch`
rt	Runtime system
sendSync	Sync a synchronous message to the actor, and block based on the configurable timeout.
status	Current status of the connector
sync	Block until this conn processes its current actor queue
syncCur	Synchronize the current values for the given points
timeout	Timeout to use for I/O and actor messaging - see `actorTimeout`.
toStr	Debug string
trace	Debug tracing for this connector
tuning	Conn tuning configuration to use for this connector.

Slot Details

close

virtual override Future close()

Force close of connection if open

data

Obj? data()

Library specific connector data. This value is managed by the connector actor via ConnDispatch.setConnData.

db

Folio db()

Runtime database

dis

Str dis()

Display name

id

virtual override Ref id()

Record id

isDisabled

Bool isDisabled()

Does the record have the disabled marker configured

lib

virtual override ConnLib lib()

Parent connector library

linger

Duration linger()

Configured linger timeout - see connLinger

log

Log log()

Log for this connector

openRetryFreq

Duration openRetryFreq()

Frequency to retry opens. See connOpenRetryFreq.

ping

virtual override Future ping()

Invoke ping request

pingFreq

Duration? pingFreq()

Configured ping frequency to test connection or null if feature is disabled - see connPingFreq

point

ConnPoint? point(Ref id, Bool checked := true)

Get the point managed by this connector via its point rec id.

pointIds

Ref[] pointIds()

Get list of all point ids managed by this connector.

points

ConnPoint[] points()

Get list of all points managed by this connector.

pollFreq

Duration? pollFreq()

Configured poll frequency if connector uses manual polling

pollMode

ConnPollMode pollMode()

Poll strategy for connector

rec

virtual override Dict rec()

Current version of the record. This dict only represents the current persistent tags. It does not track transient changes such as connStatus.

receive

virtual override Obj? receive(Obj? m)

Actor messages are routed to ConnDispatch

rt

HxRuntime rt()

Runtime system

sendSync

Obj? sendSync(HxMsg msg)

Sync a synchronous message to the actor, and block based on the configurable timeout.

status

ConnStatus status()

Current status of the connector

sync

This sync(Duration? timeout := null)

Block until this conn processes its current actor queue

syncCur

Future syncCur(ConnPoint[] points)

Synchronize the current values for the given points

timeout

Duration timeout()

Timeout to use for I/O and actor messaging - see actorTimeout.

toStr

virtual override Str toStr()

Debug string

trace

ConnTrace trace()

Debug tracing for this connector

tuning

ConnTuning tuning()

Conn tuning configuration to use for this connector.