nl.justobjects.pushlet.core
Interface Protocol

All Known Subinterfaces:
PushletClientListener
All Known Implementing Classes:
BrowserAdapter, Command, Controller, Dispatcher, Event, Pushlet, PushletApplet, PushletClient, PushletPingApplication, Session, SimpleListener, StressTester, StressTester.EventSubscriber, Subscriber

public interface Protocol

Constants for Pushlet protocols.

Version:
$Id: Protocol.java,v 1.15 2007/11/23 14:33:07 justb Exp $
Author:
Just van den Broecke - Just Objects ©

Field Summary
static java.lang.String DEFAULT_SERVLET_URI
          Default URI .
static java.lang.String E_ABORT
          S-->C Client should abort, permanent error.
static java.lang.String E_DATA
          S-->C Data.
static java.lang.String E_HEARTBEAT
          S-->C or C-->S Heartbeat.
static java.lang.String E_HEARTBEAT_ACK
          S-->C S-->C or C-->S Heartbeat confirmed.
static java.lang.String E_JOIN
          C-->S Request to join server.
static java.lang.String E_JOIN_ACK
          S-->C Acknowledgement of join.
static java.lang.String E_JOIN_LISTEN
          C-->S Request to join server.
static java.lang.String E_JOIN_LISTEN_ACK
          S-->C Acknowledgement of join.
static java.lang.String E_LEAVE
          C-->S Client leaves server.
static java.lang.String E_LEAVE_ACK
          S-->C Ack of leave.
static java.lang.String E_LISTEN
          C-->S Client starts listening.
static java.lang.String E_LISTEN_ACK
          S-->C Ack of listen.
static java.lang.String E_NACK
          S-->C Client error response, transitional error.
static java.lang.String E_PUBLISH
          C-->S Publish to subject.
static java.lang.String E_PUBLISH_ACK
          S-->C Publish to subject acknowledge.
static java.lang.String E_REFRESH
          S-->C or C-->S client refresh of data channel.
static java.lang.String E_REFRESH_ACK
          S-->C client should refresh data channel.
static java.lang.String E_SUBSCRIBE
          C-->S Subscribe to subject request.
static java.lang.String E_SUBSCRIBE_ACK
          S-->C Subscribe to subject acknowledge.
static java.lang.String E_UNSUBSCRIBE
          C-->S Unsubscribe from subject request.
static java.lang.String E_UNSUBSCRIBE_ACK
          S--C Unsubscribe from subject acknowledge.
static java.lang.String FORMAT_JAVASCRIPT
          JavaScript callback.
static java.lang.String FORMAT_SERIALIZED_JAVA_OBJECT
          Java serialized object.
static java.lang.String FORMAT_XML
          Stream of XML documents.
static java.lang.String FORMAT_XML_STRICT
          Single XML document containing zero or more events.
static java.lang.String MODE_POLL
           
static java.lang.String MODE_PULL
           
static java.lang.String MODE_STREAM
           
static java.lang.String P_EVENT
          Event type (join, leave, data, subscribe etc) .
static java.lang.String P_FORMAT
          Format to receive events
static java.lang.String P_FROM
          Originator of Event.
static java.lang.String P_ID
          Identifier for client instance within server.
static java.lang.String P_MODE
          Protocol mode.
static java.lang.String P_REASON
          Reason for errors.
static java.lang.String P_SEQ
          Event sequence number, numbers per-client.
static java.lang.String P_SUBJECT
          Subject (topic) of data event.
static java.lang.String P_SUBSCRIPTION_ID
          Subscription id, identifies single subscription.
static java.lang.String P_SUBSCRIPTION_LABEL
          Subscription label, may be used to return user-specific token with a data event, e.g.
static java.lang.String P_TIME
          Time in seconds since 1970
static java.lang.String P_TO
          Addressee of Event, subject or client p_id.
static java.lang.String P_URL
          URL attribute.
static java.lang.String P_WAIT
          Wait attribute.
static java.lang.String SUBJECT_META
           
static java.lang.String SUBJECT_META_JOINS
           
static java.lang.String SUBJECT_META_SUBS
           
 

Field Detail

DEFAULT_SERVLET_URI

static final java.lang.String DEFAULT_SERVLET_URI
Default URI .

See Also:
Constant Field Values

P_EVENT

static final java.lang.String P_EVENT
Event type (join, leave, data, subscribe etc) .

See Also:
Constant Field Values

P_TIME

static final java.lang.String P_TIME
Time in seconds since 1970

See Also:
Constant Field Values

P_SEQ

static final java.lang.String P_SEQ
Event sequence number, numbers per-client.

See Also:
Constant Field Values

P_SUBJECT

static final java.lang.String P_SUBJECT
Subject (topic) of data event.

See Also:
Constant Field Values

P_FROM

static final java.lang.String P_FROM
Originator of Event.

See Also:
Constant Field Values

P_TO

static final java.lang.String P_TO
Addressee of Event, subject or client p_id.

See Also:
Constant Field Values

P_ID

static final java.lang.String P_ID
Identifier for client instance within server.

See Also:
Constant Field Values

P_SUBSCRIPTION_ID

static final java.lang.String P_SUBSCRIPTION_ID
Subscription id, identifies single subscription.

See Also:
Constant Field Values

P_FORMAT

static final java.lang.String P_FORMAT
Format to receive events

See Also:
Constant Field Values

P_MODE

static final java.lang.String P_MODE
Protocol mode.

See Also:
Constant Field Values

P_REASON

static final java.lang.String P_REASON
Reason for errors.

See Also:
Constant Field Values

P_URL

static final java.lang.String P_URL
URL attribute.

See Also:
Constant Field Values

P_WAIT

static final java.lang.String P_WAIT
Wait attribute.

See Also:
Constant Field Values

P_SUBSCRIPTION_LABEL

static final java.lang.String P_SUBSCRIPTION_LABEL
Subscription label, may be used to return user-specific token with a data event, e.g. the name of a function for a callback.

See Also:
Constant Field Values

E_JOIN

static final java.lang.String E_JOIN
C-->S Request to join server.

See Also:
Constant Field Values

E_JOIN_ACK

static final java.lang.String E_JOIN_ACK
S-->C Acknowledgement of join.

See Also:
Constant Field Values

E_JOIN_LISTEN

static final java.lang.String E_JOIN_LISTEN
C-->S Request to join server.

See Also:
Constant Field Values

E_JOIN_LISTEN_ACK

static final java.lang.String E_JOIN_LISTEN_ACK
S-->C Acknowledgement of join.

See Also:
Constant Field Values

E_LISTEN

static final java.lang.String E_LISTEN
C-->S Client starts listening.

See Also:
Constant Field Values

E_LISTEN_ACK

static final java.lang.String E_LISTEN_ACK
S-->C Ack of listen.

See Also:
Constant Field Values

E_LEAVE

static final java.lang.String E_LEAVE
C-->S Client leaves server.

See Also:
Constant Field Values

E_LEAVE_ACK

static final java.lang.String E_LEAVE_ACK
S-->C Ack of leave.

See Also:
Constant Field Values

E_PUBLISH

static final java.lang.String E_PUBLISH
C-->S Publish to subject.

See Also:
Constant Field Values

E_PUBLISH_ACK

static final java.lang.String E_PUBLISH_ACK
S-->C Publish to subject acknowledge.

See Also:
Constant Field Values

E_SUBSCRIBE

static final java.lang.String E_SUBSCRIBE
C-->S Subscribe to subject request.

See Also:
Constant Field Values

E_SUBSCRIBE_ACK

static final java.lang.String E_SUBSCRIBE_ACK
S-->C Subscribe to subject acknowledge.

See Also:
Constant Field Values

E_UNSUBSCRIBE

static final java.lang.String E_UNSUBSCRIBE
C-->S Unsubscribe from subject request.

See Also:
Constant Field Values

E_UNSUBSCRIBE_ACK

static final java.lang.String E_UNSUBSCRIBE_ACK
S--C Unsubscribe from subject acknowledge.

See Also:
Constant Field Values

E_NACK

static final java.lang.String E_NACK
S-->C Client error response, transitional error.

See Also:
Constant Field Values

E_ABORT

static final java.lang.String E_ABORT
S-->C Client should abort, permanent error.

See Also:
Constant Field Values

E_DATA

static final java.lang.String E_DATA
S-->C Data.

See Also:
Constant Field Values

E_HEARTBEAT

static final java.lang.String E_HEARTBEAT
S-->C or C-->S Heartbeat.

See Also:
Constant Field Values

E_HEARTBEAT_ACK

static final java.lang.String E_HEARTBEAT_ACK
S-->C S-->C or C-->S Heartbeat confirmed.

See Also:
Constant Field Values

E_REFRESH

static final java.lang.String E_REFRESH
S-->C or C-->S client refresh of data channel.

See Also:
Constant Field Values

E_REFRESH_ACK

static final java.lang.String E_REFRESH_ACK
S-->C client should refresh data channel.

See Also:
Constant Field Values

FORMAT_JAVASCRIPT

static final java.lang.String FORMAT_JAVASCRIPT
JavaScript callback.

See Also:
Constant Field Values

FORMAT_SERIALIZED_JAVA_OBJECT

static final java.lang.String FORMAT_SERIALIZED_JAVA_OBJECT
Java serialized object.

See Also:
Constant Field Values

FORMAT_XML

static final java.lang.String FORMAT_XML
Stream of XML documents.

See Also:
Constant Field Values

FORMAT_XML_STRICT

static final java.lang.String FORMAT_XML_STRICT
Single XML document containing zero or more events.

See Also:
Constant Field Values

MODE_STREAM

static final java.lang.String MODE_STREAM
See Also:
Constant Field Values

MODE_PULL

static final java.lang.String MODE_PULL
See Also:
Constant Field Values

MODE_POLL

static final java.lang.String MODE_POLL
See Also:
Constant Field Values

SUBJECT_META

static final java.lang.String SUBJECT_META
See Also:
Constant Field Values

SUBJECT_META_SUBS

static final java.lang.String SUBJECT_META_SUBS
See Also:
Constant Field Values

SUBJECT_META_JOINS

static final java.lang.String SUBJECT_META_JOINS
See Also:
Constant Field Values


Copyright 2000-2003 - Just Objects B.V.