Skip to main content

EnsLib.UDP.OutboundAdapter

class EnsLib.UDP.OutboundAdapter extends Ens.OutboundAdapter

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = UDPHost:Basic,UDPPort:Basic, MaxSize:UDP, ConvertToUTF8: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 ConvertToUTF8 as %Boolean [ InitialExpression = 0 ];
Whether or not to automatically convert the message to UTF-8 before sending it. If enabled, we use one third of the potential max size for sending to account for expansion.
Property methods: ConvertToUTF8DisplayToLogical(), ConvertToUTF8Get(), ConvertToUTF8IsValid(), ConvertToUTF8LogicalToDisplay(), ConvertToUTF8Normalize(), ConvertToUTF8Set()
property MaxSize as %Integer [ InitialExpression = 0 ];
Maximum size that can be sent at a time, in bytes. This refers to bytes of content in a UDP datagram, and doesn't include headers. If the input is above this size, it will be split up into multiple datagrams. This may lead to increased unreliability, and so it is recommended to avoid sending data many times larger than the MaxSize. Should not be set higher than the maximum size for a UDP datagram or, if using one, the maximum size of a Business Service that is receiving the data being sent
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 UDPHost as %String [ InitialExpression = "127.0.0.1" ];
You can specify an IPv4 address (172.16.61.196), or an IPv6 address (::1), or a host name To find your local host name, for testing, you can Write $SYSTEM.INetInfo.LocalHostName()
Property methods: UDPHostDisplayToLogical(), UDPHostGet(), UDPHostIsValid(), UDPHostLogicalToDisplay(), UDPHostLogicalToOdbc(), UDPHostNormalize(), UDPHostSet()
property UDPHostAddress as %String (MAXLEN = 128);
Property methods: UDPHostAddressDisplayToLogical(), UDPHostAddressGet(), UDPHostAddressIsValid(), UDPHostAddressLogicalToDisplay(), UDPHostAddressLogicalToOdbc(), UDPHostAddressNormalize(), UDPHostAddressSet()
property UDPPort as %Integer [ InitialExpression = 10000 ];
Port to send to.
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 OnTearDown() as %Status
Closes the debug file before exiting
method SendStream(pInput As %Stream.Object) as %Status
Send a stream by UDP through to the host and port specified in the settings
method SendString(pInput As %String) as %Status
Send a string by UDP through to the host and port specified in the settings

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab