MessageTrackerHubService

java.lang.Object
- org.astrogrid.samp.hub.BasicHubService
- - org.astrogrid.samp.gui.GuiHubService
  - - org.astrogrid.samp.gui.MessageTrackerHubService

All Implemented Interfaces:

ClientTransmissionHolder, HubService
```
public class MessageTrackerHubService
extends GuiHubService
implements ClientTransmissionHolder
```
GuiHubService subclass which additionally keeps track of which messages have been sent and received, and can provide a graphical display of these. The overhead in maintaining the GUI display can be significant if there is high volume of message traffic.

Since:

20 Nov 2008

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`MessageTrackerHubService.CallMap` Keeps track of transmissions by key.
`private class`	`MessageTrackerHubService.MessageTrackerCallableClient` Wrapper implementation for the CallableClient class which intercepts calls to update sent and received transmission list models.
`private class`	`MessageTrackerHubService.MessageTrackerClientSet` ClientSet implementation used by this hub service.
`private class`	`MessageTrackerHubService.MessageTrackerHubClient` HubClient class used by this HubService implementation.

Field Summary

Fields
Modifier and Type	Field and Description
`private MessageTrackerHubService.CallMap`	`callMap_`
`private MessageTrackerHubService.MessageTrackerClientSet`	`clientSet_`
`private int`	`listRemoveDelay_`
`private javax.swing.ListSelectionModel`	`selectionModel_`
`private int`	`tableMaxRows_`
`private int`	`tableRemoveDelay_`
`private TransmissionTableModel`	`transTableModel_`

Fields inherited from class org.astrogrid.samp.hub.BasicHubService
MAX_TIMEOUT, MAX_WAITERS

Constructor Summary

Constructors
Constructor and Description
`MessageTrackerHubService(java.util.Random random)` Constructs a hub service with default message tracker GUI expiry times.
`MessageTrackerHubService(java.util.Random random, int listRemoveDelay, int tableRemoveDelay, int tableMaxRows)` Constructs a hub service with specified message tracker GUI expiry times.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addTransmission(Transmission trans)` Registers a newly created transmission with internal data models as required.
`HubClient`	`createClient(java.lang.String publicId, ProfileToken ptoken)` Factory method used to create all the client objects which will be used by this hub service.
`ClientSet`	`createClientSet()` Factory method used to create the client set used by this hub service.
`javax.swing.JComponent`	`createHubPanel()` Creates a new component containing a display of the current hub internal state.
`private static java.lang.Object`	`getCallKey(Client receiver, java.lang.String msgId)` Returns a key for use in the call map.
`javax.swing.ListSelectionModel`	`getClientSelectionModel()` Returns the selection model corresponding to this service's client list model.
`javax.swing.ListModel`	`getRxListModel(Client client)` Returns a ListModel representing the pending messages received by a given client.
`javax.swing.ListModel`	`getTxListModel(Client client)` Returns a ListModel representing the pending messages sent from a given client.
`protected void`	`reply(HubClient caller, java.lang.String msgId, java.util.Map response)` Does the work for the `reply` method of connections registered with this service.
`void`	`start()` Begin operation.

Methods inherited from class org.astrogrid.samp.gui.GuiHubService
createHubWindow, createMenus, declareMetadata, declareSubscriptions, getClientListModel

Methods inherited from class org.astrogrid.samp.hub.BasicHubService
call, callAll, callAndWait, createConnection, createHubMessageHandlers, disconnect, disconnectAll, getClientSet, getIdComparator, getMetadata, getRegisteredClients, getServiceConnection, getSubscribedClients, getSubscriptions, isHubRunning, notify, notifyAll, register, setCallable, shutdown, unregister

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

- Field Detail
  - callMap_
```
private final MessageTrackerHubService.CallMap callMap_
```
  - transTableModel_
```
private final TransmissionTableModel transTableModel_
```
  - listRemoveDelay_
```
private final int listRemoveDelay_
```
  - tableRemoveDelay_
```
private final int tableRemoveDelay_
```
  - tableMaxRows_
```
private final int tableMaxRows_
```
  - clientSet_
```
private MessageTrackerHubService.MessageTrackerClientSet clientSet_
```
  - selectionModel_
```
private javax.swing.ListSelectionModel selectionModel_
```
- Constructor Detail
  - MessageTrackerHubService
```
public MessageTrackerHubService(java.util.Random random)
```
    Constructs a hub service with default message tracker GUI expiry times.
    
    Parameters:
    
    random - random number generator
  - MessageTrackerHubService
```
public MessageTrackerHubService(java.util.Random random,
                                int listRemoveDelay,
                                int tableRemoveDelay,
                                int tableMaxRows)
```
    Constructs a hub service with specified message tracker GUI expiry times. The delay times are times in milliseconds after message resolution before message representations expire and hence remove themselves from gui components.
    
    Parameters:
    
    random - random number generator
    
    listRemoveDelay - expiry delay for summary icons in client list display
    
    tableRemoveDelay - expiry delay for rows in message table display
    
    tableMaxRows - maximum number of rows in message table (beyond this limit resolved messages may be removed early)
- Method Detail
  - start
```
public void start()
```
    Description copied from interface: HubService
    
    Begin operation. The HubService.register(org.astrogrid.samp.hub.ProfileToken) method should not be called until the hub has been started.
    
    Specified by:
    
    start in interface HubService
    
    Overrides:
    
    start in class GuiHubService
  - createClientSet
```
public ClientSet createClientSet()
```
    Description copied from class: BasicHubService
    
    Factory method used to create the client set used by this hub service.
    
    Overrides:
    
    createClientSet in class GuiHubService
    
    Returns:
    
    client set
  - createClient
```
public HubClient createClient(java.lang.String publicId,
                              ProfileToken ptoken)
```
    Description copied from class: BasicHubService
    
    Factory method used to create all the client objects which will be used by this hub service.
    
    Overrides:
    
    createClient in class BasicHubService
    
    Parameters:
    
    publicId - client public ID
    
    ptoken - connection source
    
    Returns:
    
    hub client
  - createHubPanel
```
public javax.swing.JComponent createHubPanel()
```
    Description copied from class: GuiHubService
    
    Creates a new component containing a display of the current hub internal state.
    
    Overrides:
    
    createHubPanel in class GuiHubService
    
    Returns:
    
    new hub viewer panel
  - getClientSelectionModel
```
public javax.swing.ListSelectionModel getClientSelectionModel()
```
    Description copied from class: GuiHubService
    
    Returns the selection model corresponding to this service's client list model.
    
    Overrides:
    
    getClientSelectionModel in class GuiHubService
    
    Returns:
    
    list selection model for client selection
  - getTxListModel
```
public javax.swing.ListModel getTxListModel(Client client)
```
    Returns a ListModel representing the pending messages sent from a given client. Elements of the model are Transmission objects.
    
    Specified by:
    
    getTxListModel in interface ClientTransmissionHolder
    
    Parameters:
    
    client - client owned by this hub service
    
    Returns:
    
    transmission list model
  - getRxListModel
```
public javax.swing.ListModel getRxListModel(Client client)
```
    Returns a ListModel representing the pending messages received by a given client. Elements of the model are Transmission objects.
    
    Specified by:
    
    getRxListModel in interface ClientTransmissionHolder
    
    Parameters:
    
    client - client owned by this hub service
    
    Returns:
    
    transmission list model
  - reply
```
protected void reply(HubClient caller,
                     java.lang.String msgId,
                     java.util.Map response)
              throws SampException
```
    Description copied from class: BasicHubService
    
    Does the work for the reply method of connections registered with this service.
    
    Overrides:
    
    reply in class BasicHubService
    
    Parameters:
    
    caller - calling client
    
    msgId - message ID
    
    response - response to forward
    
    Throws:
    
    SampException
    
    See Also:
    
    HubConnection.reply(java.lang.String, java.util.Map)
  - addTransmission
```
private void addTransmission(Transmission trans)
```
    Registers a newly created transmission with internal data models as required.
    
    Parameters:
    
    trans - new transmission to track
  - getCallKey
```
private static java.lang.Object getCallKey(Client receiver,
                                           java.lang.String msgId)
```
    Returns a key for use in the call map. Identifies a call/response mode transmission.
    
    Parameters:
    
    receiver - message receiver
    
    msgId - message ID

Class MessageTrackerHubService

Nested Class Summary

Field Summary

Fields inherited from class org.astrogrid.samp.hub.BasicHubService

Constructor Summary

Method Summary

Methods inherited from class org.astrogrid.samp.gui.GuiHubService

Methods inherited from class org.astrogrid.samp.hub.BasicHubService

Methods inherited from class java.lang.Object

Field Detail

callMap_

transTableModel_

listRemoveDelay_

tableRemoveDelay_

tableMaxRows_

clientSet_

selectionModel_

Constructor Detail

MessageTrackerHubService

MessageTrackerHubService

Method Detail

start

createClientSet

createClient

createHubPanel

getClientSelectionModel

getTxListModel

getRxListModel

reply

addTransmission

getCallKey