Object Overview

This object enables an ORMQProvider to service ORMQ clients connecting via TCP sockets. It is useful for allowing ORMQ clients running on other physical hosts to access an ORMQProvider.

A single Provider may utilize multiple Listeners, allowing for simultaneous communication over several transports (Sockets, interprocess pipes, and shared memory streams). Multiple Listeners of each type may also be defined (allowing for binding to several IPs/ports, pipes, and shared memory streams).

Example Object Definitions

... directly within an ORMQProvider object:

Minimal Configuration:

<ORMQSocketListener name="ORMQListener1" 
                    portNum="4005"/>

Overview:

An ORMQ socket listener bound to TCP port "4005", using any available local network interface.

Complex Configuration (all possible attributes shown):

<ORMQSocketListener name="ORMQListener1" tags="ORMQ listener"
                    description="ORMQ listener for socket connections"
                    listenIP="192.168.0.1" portNum="4005"/>

Overview:

An ORMQ socket listener bound to TCP port "4005" and IP address "192.168.0.1".

Supported Attributes

General Attributes:

• name - (usage: required): Public name of the configuration object. This name must be globally-unique across the entire AlchemyPoint ServerConfiguration definition.

• description - (usage: optional): Textual description of the configuration object.

• tags - (usage: optional): Space-delimited list of one or more tags used to describe the configuration object.

Object Attributes:

• portNum - (usage: required): The TCP port that this object should listen on for accepting new incoming ORMQ socket connections.

• listenIP - (usage: optional): The IP address that this object should bind to when accepting new incoming ORMQ socket connections. If this option is not specified, this object will listen on all available local network interfaces.

Supported Child Configuration Elements

None.

Issues

Unaddressed documentation issues: SSL