WsData (OpenEMS Javadoc)

java.lang.Object

io.openems.common.websocket.WsData

io.openems.backend.b2bwebsocket.WsData

public class WsData extends WsData

Constructor Summary

Constructors

Constructor

Description

WsData(B2bWebsocket parent)
Method Summary

Modifier and Type

Method

Description

void

dispose()

This method is called on close of the parent websocket.

SubscribedEdgesChannelsWorker

getSubscribedChannelsWorker()

Gets the SubscribedChannelsWorker to take care of subscribe to CurrentData.

CompletableFuture<User>

getUser()

Optional<User>

getUserOpt()

User

getUserWithTimeout(long timeout, TimeUnit unit)

Gets the logged in User with a timeout.

void

setUser(User user)

String

toString()

Provides a specific toString method.

Methods inherited from class io.openems.common.websocket.WsData
getWebsocket, handleJsonrpcResponse, send, send, setWebsocket

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

Constructor Details
- WsData
  
  public WsData(B2bWebsocket parent)
Method Details
- dispose
  
  public void dispose()
  
  Description copied from class: WsData
  
  This method is called on close of the parent websocket. Use it to release blocked resources.
  
  Overrides:
  
  dispose in class WsData
- setUser
  
  public void setUser(User user)
- getUser
  
  public CompletableFuture<User> getUser()
- getUserWithTimeout
  
  public User getUserWithTimeout(long timeout, TimeUnit unit) throws OpenemsError.OpenemsNamedException
  
  Gets the logged in User with a timeout.
  
  Parameters:
  
  timeout - the timeout length
  
  unit - the TimeUnit of the timeout
  
  Returns:
  
  the User
  
  Throws:
  
  OpenemsError.OpenemsNamedException - on error
- getUserOpt
  
  public Optional<User> getUserOpt()
- getSubscribedChannelsWorker
  
  public SubscribedEdgesChannelsWorker getSubscribedChannelsWorker()
  
  Gets the SubscribedChannelsWorker to take care of subscribe to CurrentData.
  
  Returns:
  
  the SubscribedChannelsWorker
- toString
  
  public String toString()
  
  Description copied from class: WsData
  
  Provides a specific toString method.
  
  Specified by:
  
  toString in class WsData
  
  Returns:
  
  a specific string for this instance