public.javadoc.org.spincast.plugins.undertow.UndertowWebsocketEndpointWriter.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







UndertowWebsocketEndpointWriter (org.spincast:spincast-framework 1.14.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.undertow
Interface UndertowWebsocketEndpointWriter






All Known Implementing Classes:
SpincastUndertowWebsocketEndpointWriter




public interface UndertowWebsocketEndpointWriter











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
sendClosingConnection(int closingCode,
                     String closingReason,
                     Set<String> peerIds,
                     ClosedEventSentCallback callback)
Sends a "closing connection" message to specified peers.



void
sendMessage(Set<String> peerIds,
           byte[] bytes,
           WebsocketPeersWriteCallback callback)
Sends a byte array message to specific
 peers.



void
sendMessage(Set<String> peerIds,
           String message,
           WebsocketPeersWriteCallback callback)
Sends a String message to specific
 peers.



void
sendPings(WebsocketPeersWriteCallback callback)
Sends a ping message to all peers.
















Method Detail





sendPings
void sendPings(WebsocketPeersWriteCallback callback)
Sends a ping message to all peers.







sendMessage
void sendMessage(Set<String> peerIds,
                 String message,
                 WebsocketPeersWriteCallback callback)
Sends a String message to specific
 peers.







sendMessage
void sendMessage(Set<String> peerIds,
                 byte[] bytes,
                 WebsocketPeersWriteCallback callback)
Sends a byte array message to specific
 peers.

Throws:
PeersClosedWriteException - if some peers connections were
 found to be closed when trying to write.








sendClosingConnection
void sendClosingConnection(int closingCode,
                           String closingReason,
                           Set<String> peerIds,
                           ClosedEventSentCallback callback)
Sends a "closing connection" message to specified peers.
 
 No exception thrown if the message can't be sent.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`void`	`sendClosingConnection(int closingCode, String closingReason, Set<String> peerIds, ClosedEventSentCallback callback)` Sends a "closing connection" message to specified peers.
`void`	`sendMessage(Set<String> peerIds, byte[] bytes, WebsocketPeersWriteCallback callback)` Sends a byte array message to specific peers.
`void`	`sendMessage(Set<String> peerIds, String message, WebsocketPeersWriteCallback callback)` Sends a String message to specific peers.
`void`	`sendPings(WebsocketPeersWriteCallback callback)` Sends a `ping` message to all peers.