- Index

< Previous |  | Next >

# Bidirectional Socket Input/Output Adapter Samples

## About The Samples

The TIBCO StreamBase® Bidirectional Socket Reader and Writer Adapters can be used to send and receive data over a socket connection in any format that is needed. The adapter allows the end user to provide code to transform incoming bytes into a tuple and the outgoing data into bytes to send on a socket. Two sample applications are provided.

The CustomDataTransformer sample shows how the adapters work together when linked and using a custom data transformer. When you run it, data is exchanged between the client and the server, and is parsed and modified as it transits. The data transformer uses a simple pipe delimited format with a hard coded non-printable separator character. The code in file `CustomDataTransformer.java` is called by the input and output adapters to perform the data transformations.

The OneServerOneClientNotLinked sample shows how the adapters can work independently. The reader is set up to be a server that only reads in data. The writer is set up to be the client and only sends data. When you run the sample, the writer connects to the reader and sends data. The reader reads in that data and sends that data over an arc to the writer, which in turn sends it back to the read (over the TCP socket). Client and server continue to handshake until a set number of exchanges is reached.

## Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

- From the top-level menu, select File → Load StreamBase Sample.

- Enter `bidi` to narrow the list of options.

- Select Bidirectional Socket Input/Output Adapter from the StreamBase Standard Adapters category.

- Click OK.

StreamBase Studio creates a single project containing the sample files.

## Running The Samples in StreamBase Studio

### Run the CustomDataTransformer Application

1. In the Project Explorer view, open the sample you just loaded.

   If you see red marks on a project folder, wait a moment for the project to load its features.

   If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven → Update Project from the context menu.

2. Open the `src/main/eventflow/`packageName`` folder.

3. Open the `CustomDataTransformer.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

4. In the Manual Input view select the `ControlClient` Stream. Enter `CONNECT` into the command field, and click Send Data.

5. In the Output Streams view, observe tuples emitted on the `ReadDataServer` and `ReadDataClient` output streams.

6. Select any tuple emitted from either stream and inspect tuple data fields in the Variables view below the output streams to analyze and understand their structure.

7. When done, press F9 or click the Terminate EventFlow Fragment button.

### Run the OneServerOneClientNotLinked Application

1. Continuing in the same sample, open the `OneServerOneClientNotLinked.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

2. Because the client is configured to connect on startup, the application immediately starts and runs until 250 tuples are exchanged.

3. In the Output Streams view, select All Output Streams. Observe that the first tuple comes from the ReaderStatus stream and indicates that the reader is listening on port 50000.

4. The second tuple is message from the server on the WriterStatus stream: Connected to localhost:50000

5. The third tuple, coming from the ReaderStatus stream, acknowledges the connection. For example, it might say Received connection from 127.0.0.1:60876.

6. The remaining 250 tuples are on the ReadData stream and show the client returning data tuples.

7. When done, press F9 or click the Terminate EventFlow Fragment button.

## Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

### Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

    studio-workspace/sample_adapter_embedded_bi-directional-socket

See Default Installation Directories for the default location of `studio-workspace` on your system.