eventweb.net.srvr

Class RandPortSrvrChan

java.lang.Object

eventweb.net.srvr.RandPortSrvrChan

All Implemented Interfaces:

TvOutput, SrvrChan

public class RandPortSrvrChan
extends java.lang.Object
implements SrvrChan

EventWeb backchannel server side implementation.

The backchannel is the core of the EventWeb system. It provides the connection between a EventWeb server and a EventWeb client.

Version:

1.4.3 05/15/15

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies.
int	mimeTypeId Id for MIME type used by this channel.
java.lang.String	name Identifying name for channel.
java.io.BufferedReader	reader Reader for channel.
TvReader	tvReader Tag-Value reader for channel.
TvWriter	tvWriter Tag-Value writer for channel.
static java.lang.String	VERSION Class version.
java.io.PrintWriter	writer Writer for channel.

Fields inherited from interface eventweb.net.srvr.SrvrChan

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
RandPortSrvrChan(int commMode, int connectTimeout, int activityTimeout, java.io.BufferedReader fcFromClient, java.io.PrintWriter fcToClient) Create a new RandPortSrvrChan.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Disconnect the client.
int	connect(SesnKey bcCliSesKey, SesnKey bcSrvSesKey, int mimeTypeId) Accept a client connection.
int	getMimeTypeId() Get the channel MIME type.
java.lang.String	getName() Get the channel identifier.
int	getPort() Get the local port assigned to the channel.
java.io.BufferedReader	getReader() Get the channel reader.
TvList	getRec() Read a record from the channel.
TvReader	getTvReader() Get the channel tag-value reader.
TvWriter	getTvWriter() Get the channel tag-value writer.
java.io.PrintWriter	getWriter() Get the channel writer.
void	putRec(java.lang.String tag, java.lang.String value) Write a tag value pair as a single record.
void	putRec(TvList data) Write a tag-value list as a single record.
java.lang.String	toString() Get an identifying description of the channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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.

reader

public java.io.BufferedReader reader

Reader for channel.

writer

public java.io.PrintWriter writer

Writer for channel.

tvReader

public TvReader tvReader

Tag-Value reader for channel.

tvWriter

public TvWriter tvWriter

Tag-Value writer for channel.

name

public java.lang.String name

Identifying name for channel. Comprised of client hostname and port.

mimeTypeId

public int mimeTypeId

Id for MIME type used by this channel. (Defined in MimeType class.)
Usually application/x-www-form-urlencoded, can be text/plain.

See Also:

MimeType

Constructor Detail

RandPortSrvrChan

public RandPortSrvrChan(int commMode,
                int connectTimeout,
                int activityTimeout,
                java.io.BufferedReader fcFromClient,
                java.io.PrintWriter fcToClient)
                 throws java.io.IOException

Create a new RandPortSrvrChan.

Parameters:

commMode - Communications mode

connectTimeout - Time allowed for client to connect [ms]

activityTimeout - Time to hold channel open with no activity [ms]

fcFromClient - Frontchannel connection from client

fcToClient - Frontchannel connection to client

Throws:

java.io.IOException - If there is a failure at the TCP level

Method Detail

getPort

public int getPort()

Get the local port assigned to the channel.

Specified by:

getPort in interface SrvrChan

Returns:

Port number

connect

public int connect(SesnKey bcCliSesKey,
          SesnKey bcSrvSesKey,
          int mimeTypeId)
            throws java.io.IOException

Accept a client connection.

Specified by:

connect in interface SrvrChan

Parameters:

bcCliSesKey - Client session key

bcSrvSesKey - Server session key

mimeTypeId - MIME type for communication on the channel.
(Defined in MimeType class.) @see eventweb.net.MimeType

Returns:

HTTP Status code

Throws:

java.io.IOException - If the connection fails at the TCP level

See Also:

MimeType

close

public void close()

Disconnect the client.

Specified by:

close in interface TvOutput

getName

public java.lang.String getName()

Get the channel identifier.

Specified by:

getName in interface TvOutput

Returns:

Channel name

getMimeTypeId

public int getMimeTypeId()

Get the channel MIME type.

Specified by:

getMimeTypeId in interface SrvrChan

Returns:

Channel MIME type identifier

getRec

public TvList getRec()
              throws java.io.IOException

Read a record from the channel.

Specified by:

getRec in interface SrvrChan

Returns:

Data record as a tag-value list

Throws:

java.io.IOException - If the read fails

putRec

public void putRec(java.lang.String tag,
          java.lang.String value)

Write a tag value pair as a single record.

Specified by:

putRec in interface TvOutput

Parameters:

tag - Tag part of pair

value - Value part of pair

putRec

public void putRec(TvList data)

Write a tag-value list as a single record.

Specified by:

putRec in interface TvOutput

Parameters:

data - The list to be written

getTvReader

public TvReader getTvReader()

Get the channel tag-value reader.

Specified by:

getTvReader in interface SrvrChan

Returns:

Channel tag-value reader

getTvWriter

public TvWriter getTvWriter()

Get the channel tag-value writer.

Specified by:

getTvWriter in interface SrvrChan

Returns:

Channel tag-value writer

getReader

public java.io.BufferedReader getReader()

Get the channel reader.

Specified by:

getReader in interface SrvrChan

Returns:

Underlying channel reader

getWriter

public java.io.PrintWriter getWriter()

Get the channel writer.

Specified by:

getWriter in interface SrvrChan

Returns:

Underlying channel writer

toString

public java.lang.String toString()

Get an identifying description of the channel.
Format is Bc-name/MTmimeTypeId/RW

Specified by:

toString in interface TvOutput

Overrides:

toString in class java.lang.Object