eventweb.net.http

Class RandPortCliChan

java.lang.Object

eventweb.net.http.RandPortCliChan

All Implemented Interfaces:

ChanCode, HttpCliChan

public class RandPortCliChan
extends java.lang.Object
implements HttpCliChan

Http Tag-Value messaging module.

Utilities for doing tag-value I/O over TCP from a web page. This class is the core of the client side EventWeb backchannel implementation.

This class is used by the TvIoWwgt class to provide backchannel connection to a web page. It is also used by other java classes to provide backchannel connection to non-web applications.

Version:

1.4.2 10/07/16

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
static java.lang.String	VERSION Class version

Fields inherited from interface eventweb.net.http.HttpCliChan

IF_VERSION

Fields inherited from interface eventweb.net.http.ChanCode

MAX_MODE, MODE_CHANNEL, MODE_GET, MODE_HEAD, MODE_NONE, MODE_POST, STS_CLOSED, STS_CLOSING, STS_DISCONN, STS_ERROR, STS_INIT, STS_LISTENING, STS_OPEN, STS_OPENING, STS_WARNING

Constructor Summary

Constructors

Constructor and Description
RandPortCliChan() Create a new RandPortCliChan with default session key, default media, and debugging turned off.
RandPortCliChan(java.lang.String media, boolean debug) Create a new RandPortCliChan with default session key.
RandPortCliChan(java.lang.String sessionKeyVal, java.lang.String media) Create a new RandPortCliChan with debugging turned off.
RandPortCliChan(java.lang.String sessionKeyVal, java.lang.String media, boolean debug) Create a new RandPortCliChan.

Method Summary

Methods

Modifier and Type	Method and Description
int	clearErrorStatus() Clear connection error status (if set).
boolean	closeUrl() Disconnect from URL.
boolean	dataIsAvailable() Determine if data is available.
int	getErrorCode() Return error status as HTTP status code.
int	getMode() Get channel communication mode.
int	getStatus() Get connection status.
java.lang.String[]	getTvPair() Get the next tag-value pair.
int	openUrl(java.lang.String srcUrlName) Connect to URL using the default communication mode.
int	openUrl(java.lang.String srcUrlName, int mode) Connect to URL.
int	openUrl(java.net.URL srcUrl) Connect to URL using the default communication mode.
int	openUrl(java.net.URL srcUrl, int mode) Connect to URL.
TvList	readUrl() Read a line from the URL using the current timeout.
TvList	readUrl(int timeoutMs) Set Timeout and read a line from the URL.
boolean	recHasMore() Determine if there is more data in the current record.
boolean	sendMsg(java.lang.String msg) Send message.
boolean	startMonitor(int bcReadTimeout) Start the channel monitor.
void	stopMonitor() Stop the channel monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

Constructor Detail

RandPortCliChan

public RandPortCliChan()

Create a new RandPortCliChan with default session key, default media, and debugging turned off.

RandPortCliChan

public RandPortCliChan(java.lang.String sessionKeyVal,
               java.lang.String media)

Create a new RandPortCliChan with debugging turned off.

Parameters:

sessionKeyVal - Session key for initial connection

media - Media type for the channel

RandPortCliChan

public RandPortCliChan(java.lang.String media,
               boolean debug)

Create a new RandPortCliChan with default session key.

Parameters:

media - Media type for the channel

debug - If true, debugging is turned on

RandPortCliChan

public RandPortCliChan(java.lang.String sessionKeyVal,
               java.lang.String media,
               boolean debug)

Create a new RandPortCliChan.

Parameters:

sessionKeyVal - Session key for initial connection

media - Media type for the channel

debug - If true, debugging is turned on

Method Detail

openUrl

public int openUrl(java.lang.String srcUrlName)

Connect to URL using the default communication mode.

Specified by:

openUrl in interface HttpCliChan

Parameters:

srcUrlName - The URL to connect to

Returns:

HTTP status code

openUrl

public int openUrl(java.lang.String srcUrlName,
          int mode)

Connect to URL.

Specified by:

openUrl in interface HttpCliChan

Parameters:

srcUrlName - The URL to connect to

mode - The communication mode for the channel. (One of the MODE_ values.)

Returns:

HTTP status code.

openUrl

public int openUrl(java.net.URL srcUrl)

Connect to URL using the default communication mode.

Specified by:

openUrl in interface HttpCliChan

Parameters:

srcUrl - The URL to connect to

Returns:

HTTP status code

openUrl

public int openUrl(java.net.URL srcUrl,
          int mode)

Connect to URL.

Specified by:

openUrl in interface HttpCliChan

Parameters:

srcUrl - The URL to connect to

mode - The communication mode for the channel. (One of the MODE_ values.)

Returns:

HTTP status code

closeUrl

public boolean closeUrl()

Disconnect from URL.

Specified by:

closeUrl in interface HttpCliChan

Returns:

HTTP status code

startMonitor

public boolean startMonitor(int bcReadTimeout)

Start the channel monitor.

Parameters:

bcReadTimeout - Backchannel read timeout

Returns:

true, If the monitor started successfully

stopMonitor

public void stopMonitor()

Stop the channel monitor.

getTvPair

public java.lang.String[] getTvPair()

Get the next tag-value pair.

Specified by:

getTvPair in interface HttpCliChan

Returns:

An array of two strings: tag and value

sendMsg

public boolean sendMsg(java.lang.String msg)

Send message.

Specified by:

sendMsg in interface HttpCliChan

Parameters:

msg - The message to send. This should be formatted as one or more urlencoded tag-value pairs.

Returns:

true, If the message was sent successfully.

readUrl

public TvList readUrl(int timeoutMs)

Set Timeout and read a line from the URL.

Notes:

Empty tagValList indicates no new record from server.

null tagValList indicates connection is closed.

Parameters:

timeoutMs - Read timeout in milliseconds

Returns:

Tag-Value list read from the source

readUrl

public TvList readUrl()

Read a line from the URL using the current timeout.

Notes:

Empty tagValList indicates no new record from server.

null tagValList indicates connection is closed.

Returns:

The line, as a tag-value list

dataIsAvailable

public boolean dataIsAvailable()

Determine if data is available.

Specified by:

dataIsAvailable in interface HttpCliChan

Returns:

true, If data is available

recHasMore

public boolean recHasMore()

Determine if there is more data in the current record.

Returns:

true, If more data is available

getMode

public int getMode()

Get channel communication mode.

Returns:

Communication mode. (One of the MODE_ values)

getStatus

public int getStatus()

Get connection status.

Specified by:

getStatus in interface HttpCliChan

Returns:

Connection status. (One of the STS_ values)

clearErrorStatus

public int clearErrorStatus()

Clear connection error status (if set).

Returns:

Connection status. (One of the STS_ values)

getErrorCode

public int getErrorCode()

Return error status as HTTP status code.

Returns:

HTTP status code