ptserver.communication

Class TokenPublisher

java.lang.Object

ptserver.communication.TokenPublisher

public class TokenPublisher
extends java.lang.Object

TokenPublisher batches tokens, converts to them binary and then publishes the result to the MQTT topic.

The batch is sent it out periodically according to the period parameter.

Since:

Ptolemy II 10.0

Version:

$Id: TokenPublisher.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Constructor Summary

Constructors

Constructor and Description
TokenPublisher(long period, ProxyModelInfrastructure proxyModelInfrastructure) Create instance of the TokenPublisher with specified period and tokensPerPeriod.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the publisher's timer used for sending batch of tokens.
com.ibm.mqtt.IMqttClient	getMqttClient() Return MQTT client that is used to send out MQTT messages.
java.lang.String	getTopic() Return the topic where the messages are published.
void	sendToken(Token token, ProxySink sender) Send the token via MQTT protocol.
void	setMqttClient(com.ibm.mqtt.IMqttClient mqttClient) Set the mqttClient to be used to publish the tokens.
void	setTopic(java.lang.String topic) Set the topic for the message to publish.
void	startTimer(Ticket ticket) Start the timer that sends token batches.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenPublisher

public TokenPublisher(long period,
                      ProxyModelInfrastructure proxyModelInfrastructure)

Create instance of the TokenPublisher with specified period and tokensPerPeriod.

Parameters:

period - The period in milliseconds between batches

proxyModelInfrastructure - The infrastructure that created this listener and controls the state of the execution.

Method Detail

startTimer

public void startTimer(Ticket ticket)

Start the timer that sends token batches.

Parameters:

ticket - Ticket on which to start the publishing timer.

cancel

public void cancel()

Cancel the publisher's timer used for sending batch of tokens.

getMqttClient

public com.ibm.mqtt.IMqttClient getMqttClient()

Return MQTT client that is used to send out MQTT messages.

Returns:

the mqttClient instance

See Also:

setMqttClient(IMqttClient)

getTopic

public java.lang.String getTopic()

Return the topic where the messages are published.

Returns:

the topic where the messages are published

See Also:

setTopic(String)

sendToken

public void sendToken(Token token,
                      ProxySink sender)
               throws IllegalActionException

Send the token via MQTT protocol.

The token will not be sent out immediately but would be batched for the specified period.

Parameters:

token - The token to send

sender - The sink that produced the token. If the parameter is null, then the token was not produced by the model but programmatically i.e. for monitoring purposes.

Throws:

IllegalActionException - if there is a problem with MQTT broker.

setMqttClient

public void setMqttClient(com.ibm.mqtt.IMqttClient mqttClient)

Set the mqttClient to be used to publish the tokens.

Parameters:

mqttClient - the mqttClient to be used to publish the tokens.

See Also:

getMqttClient()

setTopic

public void setTopic(java.lang.String topic)

Set the topic for the message to publish.

Parameters:

topic - the topic to publish the MQTT messages.

See Also:

getTopic()