com.cafesoft.cams.ping
Interface PingResponse

public interface PingResponse

Interface for a Response object that is used to make responses using the Ping protocol

Since:

11/15/02

Field Summary

static int	RC_GENERAL_SERVER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_NOT_APPLICABLE Reason Code: Not Applicable (because ping request succeeded)
static int	SC_FAILED Status Code indicating that ping request failed
static int	SC_PENDING Status Code indicating that ping request is in progress.
static int	SC_SUCCESS Status Code indicating that ping request succeeded

Method Summary

String	getMessage() Get the response's message
int	getReason() Get the reason code
String	getServerAddr() Get the server's address
String	getServerName() Get the server's name
int	getServerPort() Get the server's port
int	getStatus() Get the status code
void	setMessage(String message) Set the Response's message
void	setReason(int reason) Set the reason code
void	setServerAddr(String serverAddr) Set the Server's address
void	setServerName(String serverName) Set the Server's name
void	setServerPort(int serverPort) Set the Server's port
void	setStatus(int status) Set the status code

Field Detail

SC_PENDING

public static final int SC_PENDING

Status Code indicating that ping request is in progress.

See Also:

Constant Field Values

SC_SUCCESS

public static final int SC_SUCCESS

Status Code indicating that ping request succeeded

See Also:

Constant Field Values

SC_FAILED

public static final int SC_FAILED

Status Code indicating that ping request failed

See Also:

Constant Field Values

RC_NOT_APPLICABLE

public static final int RC_NOT_APPLICABLE

Reason Code: Not Applicable (because ping request succeeded)

See Also:

Constant Field Values

RC_GENERAL_SERVER_ERROR

public static final int RC_GENERAL_SERVER_ERROR

Reason Code: General Server Error, probably due to a misconfiguration.

See Also:

Constant Field Values

Method Detail

setStatus

public void setStatus(int status)

Set the status code

Parameters:

status - the status code

getStatus

public int getStatus()

Get the status code

Returns:

the response's status code

setReason

public void setReason(int reason)

Set the reason code

Parameters:

reason - the response's reason code

getReason

public int getReason()

Get the reason code

Returns:

the response's reason code

setMessage

public void setMessage(String message)

Set the Response's message

Parameters:

message - the response's message

getMessage

public String getMessage()

Get the response's message

Returns:

the response's message

setServerAddr

public void setServerAddr(String serverAddr)

Set the Server's address

Parameters:

serverAddr - the Server's address

getServerAddr

public String getServerAddr()

Get the server's address

Returns:

the server's address

setServerPort

public void setServerPort(int serverPort)

Set the Server's port

Parameters:

serverPort - the Server's port

getServerPort

public int getServerPort()

Get the server's port

Returns:

the server's port

setServerName

public void setServerName(String serverName)

Set the Server's name

Parameters:

serverName - the Server's name

getServerName

public String getServerName()

Get the server's name

Returns:

the server's name