se.rupy.http

Class Event

java.lang.Object

java.lang.Throwable

se.rupy.http.Event

All Implemented Interfaces:

java.io.Serializable

public class Event
extends java.lang.Throwable

Asynchronous HTTP request/response, this virtually represents a client socket, but in the case where the server is behind a proxy we cannot depend on that fact since sockets will be reused by multiple different external clients.

The hierarchy of the code is as follows:

Event -+-- Query <-- Input <--- +-----------+
| | |
X | Browser |
| | |
+-> Reply --> Output --> +-----------+

Where X marks the potential Comet pause point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Event.Block Non blocking IO requires some blocking logic to handle ethernet latency.

Method Summary

Methods

Modifier and Type	Method and Description
long	big(java.lang.String key)
boolean	bit(java.lang.String key)
boolean	close()
Daemon	daemon()
static java.lang.String	encode(java.lang.String value) HTML encodes.
static java.lang.String	escape(java.lang.String value) Escape JSON.
void	hold() Keeps the chunked reply open for asynchronous writes.
int	index()
Input	input()
int	medium(java.lang.String key)
Output	output()
static java.lang.String	percent(java.lang.String value) URL encodes.
void	persist() Creates a session variable to enable cross hot-deploy sessions on headless real-time comet-stream applications.
boolean	push()
Query	query()
static java.lang.String	random(int length)
java.lang.String	remote()
Reply	reply()
Session	session()
short	small(java.lang.String key)
java.lang.String	string(java.lang.String key)
byte	tiny(java.lang.String key)
java.lang.String	toString()
void	touch() Touch the worker if you have a http connection that needs to wait.
static java.lang.String	warn(int size, java.lang.String rgb) SVG warning triangle.
static java.lang.String	warn(java.lang.String message) Wraps a message with HTML and an inline SVG warning triangle.
Worker	worker()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

daemon

public Daemon daemon()

query

public Query query()

reply

public Reply reply()

session

public Session session()

remote

public java.lang.String remote()

close

public boolean close()

worker

public Worker worker()

index

public int index()

big

public long big(java.lang.String key)

Returns:

same as Query.

medium

public int medium(java.lang.String key)

Returns:

same as Query.

small

public short small(java.lang.String key)

Returns:

same as Query.

tiny

public byte tiny(java.lang.String key)

Returns:

same as Query.

bit

public boolean bit(java.lang.String key)

Returns:

same as Query.

string

public java.lang.String string(java.lang.String key)

Returns:

same as Query.

input

public Input input()

Returns:

same as Query.input().

output

public Output output()
              throws java.io.IOException

Returns:

same as Reply.output().

Throws:

java.io.IOException

encode

public static java.lang.String encode(java.lang.String value)

HTML encodes.

escape

public static java.lang.String escape(java.lang.String value)

Escape JSON.

percent

public static java.lang.String percent(java.lang.String value)

URL encodes.

warn

public static java.lang.String warn(java.lang.String message)

Wraps a message with HTML and an inline SVG warning triangle.

warn

public static java.lang.String warn(int size,
                    java.lang.String rgb)

SVG warning triangle.

persist

public void persist()

Creates a session variable to enable cross hot-deploy sessions on headless real-time comet-stream applications.

random

public static java.lang.String random(int length)
                               throws java.lang.Exception

Throws:

java.lang.Exception

push

public boolean push()

Returns:

true if the Event is being recycled due to a call to Reply.wakeup().

touch

public void touch()

Touch the worker if you have a http connection that needs to wait.

hold

public void hold()
          throws java.io.IOException

Keeps the chunked reply open for asynchronous writes. If you are streaming data and you need to send something upon the first request you have to call this in order to avoid that the trailing zero length chunk is sent to complete the response.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable