eventweb.net.http

Interface TvIo

All Known Implementing Classes:

RandPortCliChan

public interface TvIo

Tag-Value messaging interface.
Defines an interface for doing tag-value I/O over a network connection.

Version:

1.1.1 03/18/09

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IF_VERSION Interface version
static int	MAX_MODE Max valid mode
static int	MODE_CHANNEL EventWeb Backchannel
static int	MODE_GET HTTP Get
static int	MODE_HEAD HTTP Head
static int	MODE_NONE No mode specified.
static int	MODE_POST HTTP Post
static int	STS_CLOSED Closed by client
static int	STS_CLOSING (Client) Closing connection
static int	STS_DISCONN Disconnected by server
static int	STS_ERROR Error condition
static int	STS_INIT Initializing
static int	STS_LISTENING Listening for messages
static int	STS_OPEN Open to send and receive
static int	STS_OPENING Opening connection
static int	STS_WARNING Warning condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	closeUrl() Disconnect from URL.
boolean	dataIsAvailable() Determine if data is available.
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.
boolean	sendMsg(java.lang.String msg) Send message.

Field Detail

IF_VERSION

static final java.lang.String IF_VERSION

Interface version

MODE_NONE

static final int MODE_NONE

No mode specified. (min valid mode)

See Also:

Constant Field Values

MODE_HEAD

static final int MODE_HEAD

HTTP Head

See Also:

Constant Field Values

MODE_GET

static final int MODE_GET

HTTP Get

See Also:

Constant Field Values

MODE_POST

static final int MODE_POST

HTTP Post

See Also:

Constant Field Values

MODE_CHANNEL

static final int MODE_CHANNEL

EventWeb Backchannel

See Also:

Constant Field Values

MAX_MODE

static final int MAX_MODE

Max valid mode

See Also:

Constant Field Values

STS_ERROR

static final int STS_ERROR

Error condition

See Also:

Constant Field Values

STS_WARNING

static final int STS_WARNING

Warning condition

See Also:

Constant Field Values

STS_INIT

static final int STS_INIT

Initializing

See Also:

Constant Field Values

STS_DISCONN

static final int STS_DISCONN

Disconnected by server

See Also:

Constant Field Values

STS_CLOSED

static final int STS_CLOSED

Closed by client

See Also:

Constant Field Values

STS_CLOSING

static final int STS_CLOSING

(Client) Closing connection

See Also:

Constant Field Values

STS_OPENING

static final int STS_OPENING

Opening connection

See Also:

Constant Field Values

STS_OPEN

static final int STS_OPEN

Open to send and receive

See Also:

Constant Field Values

STS_LISTENING

static final int STS_LISTENING

Listening for messages

See Also:

Constant Field Values

Method Detail

openUrl

int openUrl(java.lang.String srcUrlName)

Connect to URL using the default communication mode.

Parameters:

srcUrlName - The URL to connect to

Returns:

HTTP status code

openUrl

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

Connect to URL.

Parameters:

srcUrlName - The URL to connect to

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

Returns:

HTTP status code.

openUrl

int openUrl(java.net.URL srcUrl)

Connect to URL using the default communication mode.

Parameters:

srcUrl - The URL to connect to

Returns:

HTTP status code

openUrl

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

Connect to URL.

Parameters:

srcUrl - The URL to connect to

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

Returns:

HTTP status code

closeUrl

boolean closeUrl()

Disconnect from URL.

Returns:

HTTP status code

getTvPair

java.lang.String[] getTvPair()

Get the next tag-value pair.

Returns:

An array of two strings: tag and value

sendMsg

boolean sendMsg(java.lang.String msg)

Send message.

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.

dataIsAvailable

boolean dataIsAvailable()

Determine if data is available.

Returns:

true, If data is available.

getStatus

int getStatus()

Get connection status.

Returns:

Connection status. (One of the STS_ values)