POP3 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 POP3 Reader Adapter.

Note

The adapter uses the WinPcap (Windows) and libpcap (Linux) libraries to tap into the IP packet stream. Before using this adapter with real-time data, you must install and configure these libraries on the system that will host the POP3 Reader adapter. Download and install the latest WinPcap from http://www.winpcap.org. For Linux, obtain the tcpdump package from your Linux distribution, or download, compile, and install the package from http://www.tcpdump.org.

On Windows, this adapter is supported for use with both 64-bit and 32-bit versions of StreamBase Server. Download and install the latest WinPcap version, which supports both 64-bit and 32-bit Windows. For Linux, this adapter is supported only on StreamBase built for 32-bit Linux platforms. This sample can only be run on Windows and on 32-bit Linux.

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 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\pop3reader\

On UNIX

/opt/streambase/sample/adapter/embedded/ip/pop3reader/

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_pop3reader
Windows XP:
  C:\Documents and Settings\username\My Documents\StreamBase Studio n.m Workspace\
      sample_adapter_embedded_ip_pop3reader
Windows 7 and Windows Vista:
  C:\Users\username\Documents\StreamBase Studio n.m Workspace\
      sample_adapter_embedded_ip_pop3reader

Running This Sample in StreamBase Studio

  1. In the Package Explorer, double-click to open the POP3Reader.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 a mail client to retrieve a message from a POP3 server.

  4. In the Application Output view, observe that a tuple is emitted through the POP3ReaderOutput 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 POP3Reader.sbapp.

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

  4. Use a mail client to retrieve a message from a POP3 server.

  5. A tuple representing the e-mail 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 and dequeuer:

    sbadmin shutdown