SimpleWebSocketEndpoint (kosmos-web 0.1.3.6 API)

java.lang.Object
- de.kosmos_lab.web.client.websocket.SimpleWebSocketEndpoint

Direct Known Subclasses:: WebSocketTestClient

public class SimpleWebSocketEndpoint
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SimpleWebSocketEndpoint.MessageHandler

static interface SimpleWebSocketEndpoint.RegexMessageHandler

Constructor Summary

Constructors
Constructor Description

SimpleWebSocketEndpoint(URI endpointURI)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addMessageHandler(SimpleWebSocketEndpoint.MessageHandler msgHandler)`	register message handler
`void`	`close()`
`void`	`onClose(jakarta.websocket.Session userSession, jakarta.websocket.CloseReason reason)`	Callback hook for Connection close events.
`void`	`onMessage(String message)`	Callback hook for Message Events.
`void`	`onMessage(ByteBuffer bytes)`
`void`	`onOpen(jakarta.websocket.Session userSession)`	Callback hook for Connection open events.
`void`	`sendMessage(String message)`	Send a message.

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

- Constructor Detail
  - SimpleWebSocketEndpoint
```
public SimpleWebSocketEndpoint(URI endpointURI)
```
- Method Detail
  - onOpen
```
public void onOpen(jakarta.websocket.Session userSession)
```
    Callback hook for Connection open events.
    
    Parameters:
    
    userSession - the userSession which is opened.
  - onClose
```
public void onClose(jakarta.websocket.Session userSession,
                    jakarta.websocket.CloseReason reason)
```
    Callback hook for Connection close events.
    
    Parameters:
    
    userSession - the userSession which is getting closed.
    
    reason - the reason for connection close
  - onMessage
```
public void onMessage(String message)
```
    Callback hook for Message Events. This method will be invoked when a client send a message.
    
    Parameters:
    
    message - The text message
  - onMessage
```
public void onMessage(ByteBuffer bytes)
```
  - addMessageHandler
```
public void addMessageHandler(SimpleWebSocketEndpoint.MessageHandler msgHandler)
```
    register message handler
    
    Parameters:
    
    msgHandler -
  - sendMessage
```
public void sendMessage(String message)
```
    Send a message.
    
    Parameters:
    
    message -
  - close
```
public void close()
           throws IOException
```
    Throws:
    
    IOException