EnsLib.UDP.InboundAdapter
class EnsLib.UDP.InboundAdapter extends Ens.InboundAdapter
Property Inventory
Method Inventory
Parameters
parameter SERVICEINPUTCLASS = Ens.StringContainer;
parameter SETTINGS = UDPPort:Basic, CallInterval:Basic, MaxSize:UDP, ConvertFromUTF8:UDP, UDPDebugOutputFile:Dev;
Inherited description: List of properties can be set as settings in the configuration file
format is a comma separated list of property names
Properties
property CallInterval as %Numeric (MINVAL = "0.1") [ InitialExpression = 5 ];
For this adapter, CallInterval is the number of seconds that it will listen for in a row before timing out.
Property methods: CallIntervalDisplayToLogical(), CallIntervalGet(), CallIntervalIsValid(), CallIntervalLogicalToDisplay(), CallIntervalNormalize(), CallIntervalSet()
property ConvertFromUTF8 as %Boolean [ InitialExpression = 0 ];
Whether or not to automatically convert the message received from UTF-8.
Property methods: ConvertFromUTF8DisplayToLogical(), ConvertFromUTF8Get(), ConvertFromUTF8IsValid(), ConvertFromUTF8LogicalToDisplay(), ConvertFromUTF8Normalize(), ConvertFromUTF8Set()
property MaxSize as %Integer [ InitialExpression = 0 ];
Maximum Size that can be received at a time, in bytes. This refers to bytes on the wire, not bytes of content in the datagram. Max of 65507. If a packet is too large, it won't be picked up.
Property methods: MaxSizeDisplayToLogical(), MaxSizeGet(), MaxSizeIsValid(), MaxSizeLogicalToDisplay(), MaxSizeNormalize(), MaxSizeSet()
property UDPDebugOutputFile as %String;
Path to a file to write debugging output to.
Property methods: UDPDebugOutputFileDisplayToLogical(), UDPDebugOutputFileGet(), UDPDebugOutputFileIsValid(), UDPDebugOutputFileLogicalToDisplay(), UDPDebugOutputFileLogicalToOdbc(), UDPDebugOutputFileNormalize(), UDPDebugOutputFileSet()
property UDPPort as %Integer [ InitialExpression = 10000 ];
Port to listen on.
Property methods: UDPPortDisplayToLogical(), UDPPortGet(), UDPPortIsValid(), UDPPortLogicalToDisplay(), UDPPortNormalize(), UDPPortSet()
Methods
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method OnTask() as %Status
Inherited description: default InboundAdapter behavior: always call ProcessInput on CallInterval
method OnTearDown() as %Status
We just need to attempt to close the debugging file, if it exists
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AssignOneSetting()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- CredentialsSet()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- GetSettings()
- OnKeepalive()