ProxyModelInfrastructure

java.lang.Object
- ptserver.communication.ProxyModelInfrastructure

```
public class ProxyModelInfrastructure
extends java.lang.Object
```
ProxyModelInfrastructure set ups infrastructure for executing models in a distributed mode between client and server.

Since:

Ptolemy II 10.0

Version:

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

Author:

Anar Huseynov

Accepted Rating:
Red (ahuseyno)

Proposed Rating:
Red (ahuseyno)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ProxyModelInfrastructure.ProxyModelListener
The listener that notifies about events happening in the RemoteModel.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProxyModelInfrastructure.ProxyModelListener` The listener that notifies about events happening in the RemoteModel.

Field Summary

Fields
Modifier and Type Field and Description

static int QOS_LEVEL
The quality of service that would be required from the MQTT broker.

Fields
Modifier and Type	Field and Description
`static int`	`QOS_LEVEL` The quality of service that would be required from the MQTT broker.

Constructor Summary

Constructors
Constructor and Description
`ProxyModelInfrastructure(ProxyModelBuilder.ProxyModelType modelType, CompositeActor plainTopLevelActor)` Create a new instance of the proxy model infrastructure for the specified model type from the plain model.
`ProxyModelInfrastructure(ProxyModelBuilder.ProxyModelType modelType, CompositeActor preprocessedTopLevelActor, java.util.HashMap<java.lang.String,java.lang.String> modelTypes)` Create a new instance of the ProxyModelInfrastructure of the specified type from the model that was previously converted to the one supporting distributed execution by replacing certain named objects with proxy counterparts.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProxyModelListener(ProxyModelInfrastructure.ProxyModelListener listener)` Add ProxyModelListener in order to listen for the model events such as model expiration or exception events.
`void`	`close()` Close the model along with all its connection.
`protected void`	`finalize()` Close the model before finalizing.
`void`	`fireModelConnectionExpired()` Notify the model listeners about the model connection expiration.
`void`	`fireModelException(java.lang.String message, java.lang.Throwable e)` Notify all model listeners that the simulation has experienced an exception.
`void`	`fireServerEvent(RemoteEventToken event)` Notify all model listeners that a server event has occurred.
`java.util.concurrent.Executor`	`getExecutor()` Return the executor to schedule short lived tasks.
`Manager`	`getManager()` Return the manager controlling this model.
`int`	`getMaxlatency()` Get maximum latency before the proxy sink threads are forced to sleep.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getModelTypes()` Return the model types for certain typeable object's.
`long`	`getPingPongLatency()` Return the roundtrip latency of sending ping/echo requests.
`java.util.HashMap<java.lang.String,ProxySourceData>`	`getProxySourceMap()` Return the mappings from remote source full names to their RemoteSourceData data-structure.
`java.util.HashMap<java.lang.String,ProxyValueListener>`	`getRemoteAttributeListenersMap()` Return the map with RemoteValueListeners of the model's remote attributes.
`java.util.HashMap<java.lang.String,Settable>`	`getRemoteAttributesMap()` Return the mappings from remote attribute full names to their remote Settable instance.
`java.lang.String`	`getSubscriptionTopic()` Return the subscription topic of the current model.
`Ticket`	`getTicket()` Return the ticket that uniquely identifies the model.
`int`	`getTimeoutPeriod()` Return the model's timeout period in milliseconds. if the period is less or equal to 0, the model would never timeout.
`TokenPublisher`	`getTokenPublisher()` Return the tokenPublisher used to send and batch tokens.
`CompositeActor`	`getTopLevelActor()` Return the top level actor used for running distributed simulation.
`boolean`	`isStopped()` Return true if the model is stopped, otherwise return false.
`void`	`removeProxyModelListener(ProxyModelInfrastructure.ProxyModelListener listener)` Unsubscribe the listener from the model events.
`void`	`setLastPongToken(PongToken lastPongToken)` Set the PongToken instance that was received the last.
`void`	`setMaxLatency(int maxLatency)` Set the maximum latency before the proxy sink threads are forced to sleep.
`void`	`setStopped(boolean stopped)` Set the stopped state of the model.
`void`	`setTimeoutPeriod(int timeoutPeriod)` Set the model's timeout period in milliseconds.
`Manager`	`setUpInfrastructure(Ticket ticket, java.lang.String brokerHostname)` Set up the communication infrastructure.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - QOS_LEVEL
```
public static final int QOS_LEVEL
```
    The quality of service that would be required from the MQTT broker. All messages must be send or received only once.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProxyModelInfrastructure
```
public ProxyModelInfrastructure(ProxyModelBuilder.ProxyModelType modelType,
                                CompositeActor plainTopLevelActor)
                         throws IllegalActionException,
                                TypeConflictException,
                                NameDuplicationException,
                                java.lang.CloneNotSupportedException
```
    Create a new instance of the proxy model infrastructure for the specified model type from the plain model. The model must contain markings indicating which sinks, sources or attributes are remote. The infrastructure would use ProxyModelBuilder to convert the plain model to the one that supports distributed execution.
    
    Parameters:
    
    modelType - the type of the model which must be either client or server
    
    plainTopLevelActor - The topLevelActor that has attributes indicating remote objects but that was not yet converted to the model supporting distributed execution.
    
    Throws:
    
    IllegalActionException - if there is a problem setting a manager or capturing certain type information.
    
    TypeConflictException - if there is a problem resolving types on the model.
    
    NameDuplicationException - if there is a problem creating proxy sinks or sources.
    
    java.lang.CloneNotSupportedException - if there is a problem cloning ports or attributes.
  - ProxyModelInfrastructure
```
public ProxyModelInfrastructure(ProxyModelBuilder.ProxyModelType modelType,
                                CompositeActor preprocessedTopLevelActor,
                                java.util.HashMap<java.lang.String,java.lang.String> modelTypes)
                         throws IllegalActionException
```
    Create a new instance of the ProxyModelInfrastructure of the specified type from the model that was previously converted to the one supporting distributed execution by replacing certain named objects with proxy counterparts.
    
    Parameters:
    
    modelType - The type of the model which must be either client or server
    
    preprocessedTopLevelActor - the model that was previosly processed with ProxyModelBuider and converted to the one supporting distributed execution.
    
    modelTypes - The map from the Typeable's full name to its type.
    
    Throws:
    
    IllegalActionException - if there is a problem parsing model types or setting types on Typeable objects.
- Method Detail
  - addProxyModelListener
```
public void addProxyModelListener(ProxyModelInfrastructure.ProxyModelListener listener)
```
    Add ProxyModelListener in order to listen for the model events such as model expiration or exception events.
    
    Parameters:
    
    listener - The listener to add.
    
    See Also:
    
    removeProxyModelListener(ProxyModelListener)
  - close
```
public void close()
```
    Close the model along with all its connection.
  - fireModelConnectionExpired
```
public void fireModelConnectionExpired()
```
    Notify the model listeners about the model connection expiration.
  - fireModelException
```
public void fireModelException(java.lang.String message,
                               java.lang.Throwable e)
```
    Notify all model listeners that the simulation has experienced an exception.
    
    Parameters:
    
    message - The message explaining what has happened.
    
    e - The exception (if any) that should be propagated.
  - fireServerEvent
```
public void fireServerEvent(RemoteEventToken event)
```
    Notify all model listeners that a server event has occurred.
    
    Parameters:
    
    event - The remote event
  - getExecutor
```
public java.util.concurrent.Executor getExecutor()
```
    Return the executor to schedule short lived tasks.
    It's used to send PongTokens outside of the MQTT listener thread since MQTTClient disallows that.
    
    Returns:
    
    the executor to schedule short lived tasks.
  - getManager
```
public Manager getManager()
```
    Return the manager controlling this model.
    
    Returns:
    
    the Manager controlling this model
  - getMaxlatency
```
public int getMaxlatency()
```
    Get maximum latency before the proxy sink threads are forced to sleep.
    
    Returns:
    
    the maximum latency.
    
    See Also:
    
    setMaxLatency(int)
  - getModelTypes
```
public java.util.HashMap<java.lang.String,java.lang.String> getModelTypes()
```
    Return the model types for certain typeable object's. The mapping is from the named object's full name to its Type's string representation.
    
    Returns:
    
    the _modelTypes
  - getPingPongLatency
```
public long getPingPongLatency()
```
    Return the roundtrip latency of sending ping/echo requests.
    
    Returns:
    
    the roundtrip latency of sending ping/echo requests.
  - getProxySourceMap
```
public java.util.HashMap<java.lang.String,ProxySourceData> getProxySourceMap()
```
    Return the mappings from remote source full names to their RemoteSourceData data-structure.
    
    Returns:
    
    the remoteSourceMap the mappings between full name and RemoteSourceData.
  - getRemoteAttributeListenersMap
```
public java.util.HashMap<java.lang.String,ProxyValueListener> getRemoteAttributeListenersMap()
```
    Return the map with RemoteValueListeners of the model's remote attributes.
    
    Returns:
    
    the map with RemoteValueListeners of the model's remote attributes.
  - getRemoteAttributesMap
```
public java.util.HashMap<java.lang.String,Settable> getRemoteAttributesMap()
```
    Return the mappings from remote attribute full names to their remote Settable instance.
    
    Returns:
    
    the settableAttributesMap the mappings from remote attribute full names to their remote Settable instance.
  - getSubscriptionTopic
```
public java.lang.String getSubscriptionTopic()
```
    Return the subscription topic of the current model.
    
    Returns:
    
    the subscriptionTopic used to listen for tokens from other remote model.
  - getTicket
```
public Ticket getTicket()
```
    Return the ticket that uniquely identifies the model.
    
    Returns:
    
    the ticket identifying the model.
  - getTimeoutPeriod
```
public int getTimeoutPeriod()
```
    Return the model's timeout period in milliseconds. if the period is less or equal to 0, the model would never timeout.
    
    Returns:
    
    the timeoutPeriod of the model.
    
    See Also:
    
    setTimeoutPeriod(int)
  - getTokenPublisher
```
public TokenPublisher getTokenPublisher()
```
    Return the tokenPublisher used to send and batch tokens.
    
    Returns:
    
    The token publisher used for sending tokens.
  - getTopLevelActor
```
public CompositeActor getTopLevelActor()
```
    Return the top level actor used for running distributed simulation.
    
    Returns:
    
    the topLevelActor of the model.
  - isStopped
```
public boolean isStopped()
```
    Return true if the model is stopped, otherwise return false.
    
    Returns:
    
    the stopped state of the model.
    
    See Also:
    
    setStopped(boolean)
  - removeProxyModelListener
```
public void removeProxyModelListener(ProxyModelInfrastructure.ProxyModelListener listener)
```
    Unsubscribe the listener from the model events.
    
    Parameters:
    
    listener - The listener to remove.
    
    See Also:
    
    addProxyModelListener(ProxyModelListener)
  - setLastPongToken
```
public void setLastPongToken(PongToken lastPongToken)
```
    Set the PongToken instance that was received the last.
    
    Parameters:
    
    lastPongToken - The last PongToken.
  - setMaxLatency
```
public void setMaxLatency(int maxLatency)
```
    Set the maximum latency before the proxy sink threads are forced to sleep.
    
    Parameters:
    
    maxLatency - the maximum latency.
    
    See Also:
    
    getMaxlatency()
  - setStopped
```
public void setStopped(boolean stopped)
```
    Set the stopped state of the model.
    
    Parameters:
    
    stopped - indicates if the model is stopped or not.
    
    See Also:
    
    isStopped()
  - setTimeoutPeriod
```
public void setTimeoutPeriod(int timeoutPeriod)
```
    Set the model's timeout period in milliseconds. If the period is set to 0 or less, the model would never timeout.
    
    Parameters:
    
    timeoutPeriod - the timeout period of the model.
    
    See Also:
    
    getTimeoutPeriod()
  - setUpInfrastructure
```
public Manager setUpInfrastructure(Ticket ticket,
                                   java.lang.String brokerHostname)
                            throws com.ibm.mqtt.MqttException,
                                   IllegalActionException
```
    Set up the communication infrastructure.
    
    Parameters:
    
    ticket - The ticket associated with this remote model.
    
    brokerHostname - The hostname of the MQTT broker.
    
    Returns:
    
    The manager of the model
    
    Throws:
    
    com.ibm.mqtt.MqttException - If there is a problem connecting to the broker.
    
    IllegalActionException - If there is problem creating the manager.
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Close the model before finalizing.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable - If finalizing fails to close model and/or connections.
    
    See Also:
    
    Object.finalize()

Class ProxyModelInfrastructure

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QOS_LEVEL

Constructor Detail

ProxyModelInfrastructure

ProxyModelInfrastructure

Method Detail

addProxyModelListener

close

fireModelConnectionExpired

fireModelException

fireServerEvent

getExecutor

getManager

getMaxlatency

getModelTypes

getPingPongLatency

getProxySourceMap

getRemoteAttributeListenersMap

getRemoteAttributesMap

getSubscriptionTopic

getTicket

getTimeoutPeriod

getTokenPublisher

getTopLevelActor

isStopped

removeProxyModelListener

setLastPongToken

setMaxLatency

setStopped

setTimeoutPeriod

setUpInfrastructure

finalize