Package org.openwebnet4j.communication

Class Response

java.lang.Object

org.openwebnet4j.communication.Response

public class Response
extends Object

This class represents a response to a OpenWebNet request sent to the gateway. Can contain multiple messages (frames), last message should be an ACK/NACK.

Author:

M. Valla - Initial contribution

Constructor Summary

Constructors

Constructor	Description
Response(OpenMessage request)	Creates a Response object associated to the request message

Method Summary

Modifier and Type	Method	Description
protected void	addResponse(OpenMessage msg)	Add a new message received as response
OpenMessage	getFinalResponse()	Returns the last OpenMessage that has finalised this response
OpenMessage	getRequest()	Returns the initial request message
List<OpenMessage>	getResponseMessages()	Returns a list of OpenMessage received as response
protected boolean	hasFinalResponse()	Returns true if an ACK/NACK has been received
boolean	isSuccess()	Returns true if the request was successful (the last OpenMessages in the response is an ACK)
protected void	responseReady()
String	toString()
protected void	waitResponse()

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response(OpenMessage request)

Creates a Response object associated to the request message

Parameters:

request - the OpenMessage request message

Method Detail

getRequest

public OpenMessage getRequest()

Returns the initial request message

Returns:

the initial request message

isSuccess

public boolean isSuccess()

Returns true if the request was successful (the last OpenMessages in the response is an ACK)

Returns:

true if the request was successful

getResponseMessages

public List<OpenMessage> getResponseMessages()

Returns a list of OpenMessage received as response

Returns:

a list of OpenMessage

getFinalResponse

public OpenMessage getFinalResponse()

Returns the last OpenMessage that has finalised this response

Returns:

the last OpenMessage

toString

public String toString()

Overrides:

toString in class Object

addResponse

protected void addResponse(OpenMessage msg)

Add a new message received as response

Parameters:

msg - the new message to add

hasFinalResponse

protected boolean hasFinalResponse()

Returns true if an ACK/NACK has been received

Returns:

true if an ACK/NACK has been received

waitResponse

protected void waitResponse()

responseReady

protected void responseReady()