Package org.yamcs

Class ConnectedClient

java.lang.Object

org.yamcs.ConnectedClient

Direct Known Subclasses:

ConnectedWebSocketClient

public class ConnectedClient
extends Object

A client connected to Yamcs Clients may optionally be connected with a processor.

Constructor Summary

Constructors

Constructor	Description
ConnectedClient(User user, String applicationName, String address)
ConnectedClient(User user, String applicationName, String address, Processor processor)

Method Summary

Modifier and Type	Method	Description
String	getAddress()
String	getApplicationName()	Descriptive application name of the connected client
int	getId()
long	getLoginTime()	The time at which the client connected to Yamcs
Processor	getProcessor()
User	getUser()	The user associated with the connected client
void	processorQuit()	Called when the processor is closing down
void	setClientId(int clientId)
void	setProcessor(Processor processor)	Select or change the processor for this client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedClient

public ConnectedClient(User user,
                       String applicationName,
                       String address)

ConnectedClient

public ConnectedClient(User user,
                       String applicationName,
                       String address,
                       Processor processor)

Method Detail

getId

public int getId()

setClientId

public void setClientId(int clientId)

getUser

public User getUser()

The user associated with the connected client

getApplicationName

public String getApplicationName()

Descriptive application name of the connected client

getAddress

public String getAddress()

getLoginTime

public long getLoginTime()

The time at which the client connected to Yamcs

setProcessor

public void setProcessor(Processor processor)
                  throws ProcessorException

Select or change the processor for this client.

Parameters:

processor - the processor to select

Throws:

ProcessorException

processorQuit

public void processorQuit()

Called when the processor is closing down

getProcessor

public Processor getProcessor()

Returns:

the current processor the client is connected to (if any).