Record Class WSConnectionSettingsResource
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.gan.WSConnectionSettingsResource
- Record Components:
host
- The remote host to connect toport
- The remote port to connect touseSSL
- Whether to use SSL for the connectionpingRateMillis
- The rate at which to send ping messagespingTimeoutMillis
- The timeout for a ping messagepingMaxMissed
- The maximum number of missed pings before the connection is considered lostwsTimeoutMillis
- The timeout for the websocket connectionhttpConnectTimeoutMillis
- The timeout for the HTTP connectionhttpReadTimeoutMillis
- The timeout for reading from the HTTP connectionsendThreads
- The number of threads to use for sending messagesreceiveThreads
- The number of threads to use for receiving messages
public record WSConnectionSettingsResource(String host, Integer port, Boolean useSSL, Integer pingRateMillis, Integer pingTimeoutMillis, Integer pingMaxMissed, Integer wsTimeoutMillis, Integer httpConnectTimeoutMillis, Integer httpReadTimeoutMillis, Integer sendThreads, Integer receiveThreads)
extends Record
A resource that holds settings for an outgoing Gateway Network connection. Notably, this is a named resource which
did not have a name in the previous PersistentRecord implementation, so the resource name is constructed as
host_port.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ResourceTypeMeta<WSConnectionSettingsResource>
static final String
static final ResourceType
-
Constructor Summary
ConstructorsConstructorDescriptionWSConnectionSettingsResource
(String host, Integer port, Boolean useSSL, Integer pingRateMillis, Integer pingTimeoutMillis, Integer pingMaxMissed, Integer wsTimeoutMillis, Integer httpConnectTimeoutMillis, Integer httpReadTimeoutMillis, Integer sendThreads, Integer receiveThreads) Creates an instance of aWSConnectionSettingsResource
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.getAllProperties
(int index) Returns a Properties object that can be used to completely recreate a WSConnectionSettingsResource from properties.final int
hashCode()
Returns a hash code value for this object.host()
Returns the value of thehost
record component.Returns the value of thehttpConnectTimeoutMillis
record component.Returns the value of thehttpReadTimeoutMillis
record component.Returns the value of thepingMaxMissed
record component.Returns the value of thepingRateMillis
record component.Returns the value of thepingTimeoutMillis
record component.port()
Returns the value of theport
record component.Returns the value of thereceiveThreads
record component.Returns the value of thesendThreads
record component.final String
toString()
Returns a string representation of this record class.useSSL()
Returns the value of theuseSSL
record component.Returns the value of thewsTimeoutMillis
record component.
-
Field Details
-
OUTGOING_CONNECTIONS
- See Also:
-
RESOURCE_TYPE
-
META
-
-
Constructor Details
-
WSConnectionSettingsResource
public WSConnectionSettingsResource(String host, Integer port, Boolean useSSL, Integer pingRateMillis, Integer pingTimeoutMillis, Integer pingMaxMissed, Integer wsTimeoutMillis, Integer httpConnectTimeoutMillis, Integer httpReadTimeoutMillis, Integer sendThreads, Integer receiveThreads) Creates an instance of aWSConnectionSettingsResource
record class.- Parameters:
host
- the value for thehost
record componentport
- the value for theport
record componentuseSSL
- the value for theuseSSL
record componentpingRateMillis
- the value for thepingRateMillis
record componentpingTimeoutMillis
- the value for thepingTimeoutMillis
record componentpingMaxMissed
- the value for thepingMaxMissed
record componentwsTimeoutMillis
- the value for thewsTimeoutMillis
record componenthttpConnectTimeoutMillis
- the value for thehttpConnectTimeoutMillis
record componenthttpReadTimeoutMillis
- the value for thehttpReadTimeoutMillis
record componentsendThreads
- the value for thesendThreads
record componentreceiveThreads
- the value for thereceiveThreads
record component
-
-
Method Details
-
getAllProperties
Returns a Properties object that can be used to completely recreate a WSConnectionSettingsResource from properties. Use the index to set which gan connection this represents in a file with many gan connections; e.g if the index is 0, then a property might be 'gateway.network.0.Host=localhost' -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
host
Returns the value of thehost
record component.- Returns:
- the value of the
host
record component
-
port
Returns the value of theport
record component.- Returns:
- the value of the
port
record component
-
useSSL
Returns the value of theuseSSL
record component.- Returns:
- the value of the
useSSL
record component
-
pingRateMillis
Returns the value of thepingRateMillis
record component.- Returns:
- the value of the
pingRateMillis
record component
-
pingTimeoutMillis
Returns the value of thepingTimeoutMillis
record component.- Returns:
- the value of the
pingTimeoutMillis
record component
-
pingMaxMissed
Returns the value of thepingMaxMissed
record component.- Returns:
- the value of the
pingMaxMissed
record component
-
wsTimeoutMillis
Returns the value of thewsTimeoutMillis
record component.- Returns:
- the value of the
wsTimeoutMillis
record component
-
httpConnectTimeoutMillis
Returns the value of thehttpConnectTimeoutMillis
record component.- Returns:
- the value of the
httpConnectTimeoutMillis
record component
-
httpReadTimeoutMillis
Returns the value of thehttpReadTimeoutMillis
record component.- Returns:
- the value of the
httpReadTimeoutMillis
record component
-
sendThreads
Returns the value of thesendThreads
record component.- Returns:
- the value of the
sendThreads
record component
-
receiveThreads
Returns the value of thereceiveThreads
record component.- Returns:
- the value of the
receiveThreads
record component
-