CADI.Server.Core
Class TasksQueueNode

java.lang.Object
  CADI.Server.Core.TasksQueueNode

public class TasksQueueNode
extends java.lang.Object

This is an auxiliary class used to save the tasks that will be done by a Worker thread. Two different types of works can be definded:

• If the statusCode is 0, it is a work to be processed by Worker thread.
• If the statusCode is not 0, the task is for sending an error message to the client. The status code of the HTTP response is given through the statusCode attribute and the reason phrase is given through the reashonPhrase attribute. An the socket to send the data to the client is the socket attribute.

Version:

1.0 2008/02/21

Author:

Group on Interactive Coding of Images (GICI)

See Also:

TasksQueue

Field Summary

(package private) HTTPRequest	httpRequest
(package private) JPIPRequestFields	jpipRequestFields Definition in JPIPRequestFields.
(package private) java.lang.String	reasonPhrase Is the reason phrase of the HTTP response.
(package private) java.net.Socket	socket Is the socket that will used to communicate with the client.
(package private) int	statusCode This attribute is used to identify the kind of work.

Constructor Summary

TasksQueueNode(java.net.Socket socket, HTTPRequest httpRequest, JPIPRequestFields jpipRequestFields)
Constructor.

TasksQueueNode(java.net.Socket socket, int statusCode, java.lang.String reasonPhrase)
Constructor.

Method Summary

HTTPRequest	getHttpRequestFields() Returns the httpRequest attribute.
JPIPRequestFields	getJpipRequestFields() Returns the jpipRequestFields attribute.
java.lang.String	getReasonPhrase() Returns the reasonPhrase attribute.
java.net.Socket	getSocket() Returns the client socket.
int	getStatusCode() Returns the status code.
void	list(java.io.PrintStream out) Prints this Tasks Queue Node fields out to the specified output stream.
void	reset() Set attributes to its initial values.
java.lang.String	toString() For debugging purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

statusCode

int statusCode

This attribute is used to identify the kind of work. They are:

• If it is 0, a common work is stored. Only the socket, httpRequest, and jpipRequestFields attributes are used.
• Otherwise, the work is for sending an error message to the client. Therefore, the this attribute indicates the HTTP response, and the reasonPhrase of the HTTP response is given in the reasonPhrase attribute.

socket

java.net.Socket socket

Is the socket that will used to communicate with the client.

httpRequest

HTTPRequest httpRequest

See Also:

statusCode

jpipRequestFields

JPIPRequestFields jpipRequestFields

Definition in JPIPRequestFields.

reasonPhrase

java.lang.String reasonPhrase

Is the reason phrase of the HTTP response.

See Also:

statusCode

Constructor Detail

TasksQueueNode

public TasksQueueNode(java.net.Socket socket,
                      HTTPRequest httpRequest,
                      JPIPRequestFields jpipRequestFields)

Constructor.

Parameters:

socket - is the client socket.

httpRequest -

jpipRequestFields -

TasksQueueNode

public TasksQueueNode(java.net.Socket socket,
                      int statusCode,
                      java.lang.String reasonPhrase)

Constructor.

Parameters:

socket -

statusCode -

reasonPhrase -

Method Detail

getStatusCode

public int getStatusCode()

Returns the status code. See statusCode.

Returns:

the status code

getSocket

public java.net.Socket getSocket()

Returns the client socket.

Returns:

client socket

getHttpRequestFields

public HTTPRequest getHttpRequestFields()

Returns the httpRequest attribute.

Returns:

the httpRequest.

getJpipRequestFields

public JPIPRequestFields getJpipRequestFields()

Returns the jpipRequestFields attribute.

Returns:

the jpipRequestFields.

getReasonPhrase

public java.lang.String getReasonPhrase()

Returns the reasonPhrase attribute.

Returns:

the reasonPhrase.

reset

public void reset()

Set attributes to its initial values.

toString

public java.lang.String toString()

For debugging purposes.

Overrides:

toString in class java.lang.Object

list

public void list(java.io.PrintStream out)

Prints this Tasks Queue Node fields out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.