Open Kilda Java Documentation
org.openkilda.messaging.ctrl.CtrlRequest Class Reference
Inheritance diagram for org.openkilda.messaging.ctrl.CtrlRequest:
org.openkilda.messaging.Message org.openkilda.messaging.BaseMessage

Public Member Functions

 CtrlRequest (@JsonProperty(ROUTE) String route, @JsonProperty(PAYLOAD) final RequestData data, @JsonProperty(TIMESTAMP) final long timestamp, @JsonProperty(CORRELATION_ID) final String correlationId, @JsonProperty(DESTINATION) final Destination destination)
 
RequestData getData ()
 
String getRoute ()
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.Message
 Message (@JsonProperty(TIMESTAMP) final long timestamp, @JsonProperty(CORRELATION_ID) final String correlationId, @JsonProperty(DESTINATION) final Destination destination)
 
 Message (final long timestamp, final String correlationId)
 
String getCorrelationId ()
 
Destination getDestination ()
 
void setDestination (final Destination destination)
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.BaseMessage
 BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
 
 BaseMessage ()
 
long getTimestamp ()
 
void setTimestamp (long timestamp)
 

Additional Inherited Members

- Static Public Member Functions inherited from org.openkilda.messaging.BaseMessage
static final< T extends BaseMessage > T getMessage (String json, Class< T > type) throws java.io.IOException
 
static final< T extends BaseMessage > T tryGetMessage (String json, Class< T > type)
 
- Protected Attributes inherited from org.openkilda.messaging.Message
String correlationId
 
Destination destination
 
- Protected Attributes inherited from org.openkilda.messaging.BaseMessage
long timestamp = 0L
 

Detailed Description

Class represents CTRL request message.

Definition at line 39 of file CtrlRequest.java.

Constructor & Destructor Documentation

◆ CtrlRequest()

org.openkilda.messaging.ctrl.CtrlRequest.CtrlRequest ( @JsonProperty(ROUTE) String  route,
@JsonProperty(PAYLOAD) final RequestData  data,
@JsonProperty(TIMESTAMP) final long  timestamp,
@JsonProperty(CORRELATION_ID) final String  correlationId,
@JsonProperty(DESTINATION) final Destination  destination 
)

Instance constructor.

Parameters
datactrl message payload
timestamptimestamp value
correlationIdmessage correlation id
destinationmessage destination

Definition at line 63 of file CtrlRequest.java.

Member Function Documentation

◆ getData()

RequestData org.openkilda.messaging.ctrl.CtrlRequest.getData ( )

Returns payload of the ctrl message.

Returns
ctrl message payload

Definition at line 78 of file CtrlRequest.java.

◆ getRoute()

String org.openkilda.messaging.ctrl.CtrlRequest.getRoute ( )

Definition at line 82 of file CtrlRequest.java.

◆ toString()

String org.openkilda.messaging.ctrl.CtrlRequest.toString ( )

Definition at line 90 of file CtrlRequest.java.


The documentation for this class was generated from the following file: