eventweb.net.http

Interface HttpCliChan

All Superinterfaces:

ChanCode

All Known Implementing Classes:

RandPortCliChan

public interface HttpCliChan
extends ChanCode

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

Version:

1.2.0 05/08/15

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IF_VERSION Interface 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

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

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)