IRC Reader Input Adapter Sample

Contents

Importing this Sample into StreamBase Studio
Sample Location
Running This Sample in StreamBase Studio
Running This Sample in Terminal Windows

This sample demonstrates how to use the StreamBase IRC Reader Adapter.

Note

The adapter uses the libpcap (Linux) and WinPcap (Windows) libraries to tap into the IP packet stream. Before using this adapter with realtime data, you must install and configure these libraries on the system that will host the IRC Reader adapter. Locate libpcap at http://www.tcpdump.org/ and WinPcap at http://www.winpcap.org.

Importing this Sample into StreamBase Studio

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

  • From the top menu, click File → Load StreamBase Sample.

  • Select this sample from the Embedded Input Adapters list.

  • Click OK.

StreamBase Studio creates a single project containing the sample files.

Sample Location

By default, the sample files are installed in:

On Windows

C:\Program Files\StreamBase Systems\StreamBase.n.m\sample\adapter\embedded\ip\ircreader\

On UNIX

/opt/streambase/sample/adapter/embedded/ip/ircreader/

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace. StreamBase Systems recommends that you use the workspace copy of the sample, especially on UNIX, where you may not have write access to /opt/streambase. In the default installation, the path to this sample in your Studio workspace is: 

UNIX:       
  ~/streambase-studio-n.m-workspace/sample_adapter_embedded_ip_ircreader
Windows XP:
  C:\Documents and Settings\username\My Documents\StreamBase Studio n.m Workspace\
      sample_adapter_embedded_ip_ircreader
Windows Vista:
  C:\Users\username\Documents\StreamBase Studio n.m Workspace\
      sample_adapter_embedded_ip_ircreader

Running This Sample in StreamBase Studio

  1. In the Package Explorer, double-click to open the IRCReader.sbapp application. Make sure the application is the currently active tab in the EventFlow Editor.

  2. Click the Run button. This opens the SB Test/Debug perspective and starts the application.

  3. Use an IRC chat client to retrieve a message from an IRC server.

  4. In the Application Output view, observe that a tuple is emitted through the IRCReaderOutput stream.

  5. When done, press F9 or click the Stop Running Application button.

Running This Sample in Terminal Windows

This section describes how to run the sample in UNIX terminal windows or Windows command prompt windows. On Windows, be sure to use the StreamBase Command Prompt from the Start menu as described in the Test/Debug Guide, not the default command prompt.

  1. Open two terminal windows on UNIX, or two StreamBase Command Prompts on Windows. In each window, navigate to the directory where the sample is installed, or to your workspace copy of the sample, as described above.

  2. In window 1, type: sbd IRCReader.sbapp.

  3. In window 2, start a dequeuer by typing: sbc dequeue IRCReaderOutput.

  4. Use an IRC chat client to retrieve a message from an IRC server.

  5. A tuple representing the chat message appears in window 2.

  6. In window 2, type: Ctrl-C to exit the sbc session.

  7. In window 2, type the following command to terminate the server:

    sbadmin shutdown