Using TCP Adapters with Ensemble - InterSystems Documentation

6Using the TCP Text Line Inbound AdapterEnsLib.TCP.TextLineInboundAdapter is the adapter class to use for incoming TCP connections over which a TCP client andTCP listener exchange data as text strings that end with a line terminator character. The default terminator is the newlinecharacter (ASCII 10).This chapter explains how to use the EnsLib.TCP.TextLineInboundAdapter. It discusses the following topics:• Background Information• Using the Adapter• Creating a New Business Service Class• Sample Business Service Class Code• Adapter Settings• Adding a TCP Status ServiceAn important example of a business service that uses the EnsLib.TCP.TextLineInboundAdapter is the built-in business serviceclass EnsLib.TCP.StatusService. This class provides a command-line interface that allows a console user or command-linescript to retrieve basic status information from a running Ensemble production. For more information, see “TCP StatusService” at the end of this chapter.6.1 Background InformationYou can simply set up the EnsLib.TCP.TextLineInboundAdapter as instructed in the next section, “Using the Adapter.”However, some developers want more details about how the adapter communicates with its configured business service.This section provides those details.If you look at the EnsLib.TCP.TextLineInboundAdapter class code, you see that it contains a call to an Ensemble frameworkmethod called ProcessInput(). However, the code for the business service class provides a method called OnProcessInput().This section explains the relationship between the two methods. If you want to view Ensemble class code, try the following:• In Studio, from the Tools menu choose Class Browser. The Class Browser dialog displays. In the window at left, navigatethe hierarchy to find the class of interest. In the window at right, display details about class members and theclass hierarchy by clicking the tabs along the lower edge of the display: All, Properties, Methods, Parameters, and soon.• In Studio, from the Help menu choose On-line Documentation. The documentation home page displays. Scroll downand choose Class Reference Information. The Caché Class Reference home page displays. At top left, for Classes inchoose an Ensemble-enabled namespace. Navigate the hierarchy of package names to find the class of interest.Using TCP Adapters with Ensemble 35