- Index
- »
- fan.hxConn
- »
- Conn
Conn
const class Conn : Actor
Conn models a connection to a single endpoint.
Force close of connection if open
Library specific connector data
Project database
Display name
Parent connector library
Record id
Does the record have the disabled marker configured
Configured linger timeout - see connLinger
Log for this connector
Frequency to retry opens
Invoke ping request
Configured ping frequency to test connection or null if feature is disabled - see connPingFreq
Get the point managed by this connector via its point rec id
Get list of all point ids managed by this connector
Get list of all points managed by this connector
Configured poll frequency if connector uses manual polling
Poll strategy for connector
Project
Current version of the record
Actor messages are routed to ConnDispatch
Sync a synchronous message to the actor, and block based on the configurable timeout
Current status of the connector
Block until this conn processes its current actor queue
Synchronize the current values for the given points
Timeout to use for I/O and actor messaging - see actorTimeout
Debug string
Debug tracing for this connector
Conn tuning configuration to use for this connector
virtual Future close()
Force close of connection if open
Obj? data()
Library specific connector data. This value is managed by the connector actor via ConnDispatch.setConnData.
Folio db()
Project database
Str dis()
Display name
virtual ConnExt ext()
Parent connector library
virtual Ref id()
Record id
Bool isDisabled()
Does the record have the disabled marker configured
Duration linger()
Configured linger timeout - see connLinger
Log log()
Log for this connector
Duration openRetryFreq()
Frequency to retry opens. See connOpenRetryFreq.
virtual Future ping()
Invoke ping request
Duration? pingFreq()
Configured ping frequency to test connection or null if feature is disabled - see connPingFreq
ConnPoint? point(Ref id, Bool checked := true)
Get the point managed by this connector via its point rec id.
Ref[] pointIds()
Get list of all point ids managed by this connector.
ConnPoint[] points()
Get list of all points managed by this connector.
Duration? pollFreq()
Configured poll frequency if connector uses manual polling
ConnPollMode pollMode()
Poll strategy for connector
Proj proj()
Project
virtual Dict rec()
Current version of the record.
This dict only represents the current persistent tags.
It does not track transient changes such as connStatus.
virtual Obj? receive(Obj? m)
Actor messages are routed to ConnDispatch
Obj? sendSync(HxMsg msg)
Sync a synchronous message to the actor, and block based on the configurable timeout.
ConnStatus status()
Current status of the connector
This sync(Duration? timeout := null)
Block until this conn processes its current actor queue
Future syncCur(ConnPoint[] points)
Synchronize the current values for the given points
Duration timeout()
Timeout to use for I/O and actor messaging - see actorTimeout.
virtual Str toStr()
Debug string
ConnTrace trace()
Debug tracing for this connector
ConnTuning tuning()
Conn tuning configuration to use for this connector.