FilesExpand file tree

 master

/

WebSocket.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

114 lines (88 loc) · 3.94 KB

 master

/

WebSocket.java

Copy path

Top

File metadata and controls

• Code
• Blame

114 lines (88 loc) · 3.94 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

package org.java_websocket;

import java.io.IOException;

import java.net.InetSocketAddress;

import java.nio.ByteBuffer;

import java.nio.channels.NotYetConnectedException;

import org.java_websocket.exceptions.InvalidDataException;

import org.java_websocket.exceptions.InvalidHandshakeException;

import org.java_websocket.framing.Framedata;

import org.java_websocket.handshake.ClientHandshakeBuilder;

public abstract class WebSocket {

public enum Role {

CLIENT, SERVER

}

public static int RCVBUF = 256;

public static/*final*/boolean DEBUG = false; // must be final in the future in order to take advantage of VM optimization

public static final int READY_STATE_CONNECTING = 0;

public static final int READY_STATE_OPEN = 1;

public static final int READY_STATE_CLOSING = 2;

public static final int READY_STATE_CLOSED = 3;

/**

* The default port of WebSockets, as defined in the spec. If the nullary

* constructor is used, DEFAULT_PORT will be the port the WebSocketServer

* is binded to. Note that ports under 1024 usually require root permissions.

*/

public static final int DEFAULT_PORT = 80;

/**

* sends the closing handshake.

* may be send in response to an other handshake.

*/

public abstract void close( int code, String message );

/**

* closes the socket no matter if the closing handshake completed.

* Does not send any not yet written data before closing.

* Calling this method more than once will have no effect.

*

* @param remote

* Indicates who "generated" <code>code</code>.<br>

* <code>true</code> means that this endpoint received the <code>code</code> from the other endpoint.<br>

* false means this endpoint decided to send the given code,<br>

* <code>remote</code> may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the <code>code</code> but close the connection the same time this endpoint does do but with an other <code>code</code>. <br>

**/

public abstract void closeConnection( int code, String message, boolean remote );

public abstract void closeConnection( int code, boolean remote );

public abstract void close( int code );

public abstract void close( InvalidDataException e );

/**

* Send Text data to the other end.

*

* @throws IllegalArgumentException

* @throws InterruptedException

* @throws NotYetConnectedException

*/

public abstract void send( String text ) throws NotYetConnectedException;

/**

* Send Binary data (plain bytes) to the other end.

*

* @throws IllegalArgumentException

* @throws InterruptedException

* @throws NotYetConnectedException

*/

public abstract void send( ByteBuffer bytes ) throws IllegalArgumentException , NotYetConnectedException , InterruptedException;

public abstract void send( byte[] bytes ) throws IllegalArgumentException , NotYetConnectedException , InterruptedException;

public abstract void sendFrame( Framedata framedata );

public abstract boolean hasBufferedData();

/**

* The amount of data in Queue, ready to be sent.

*

* @return Amount of Data still in Queue and not sent yet of the socket

*/

public abstract long bufferedDataAmount();

/** Returns whether the batch process all available data */

public abstract boolean batch() throws IOException;

public abstract void startHandshake( ClientHandshakeBuilder handshakedata ) throws InvalidHandshakeException , InterruptedException;

public abstract InetSocketAddress getRemoteSocketAddress();

public abstract InetSocketAddress getLocalSocketAddress();

public abstract boolean isConnecting();

public abstract boolean isOpen();

public abstract boolean isClosing();

public abstract boolean isClosed();

/**

* Retrieve the WebSocket 'readyState'.

* This represents the state of the connection.

* It returns a numerical value, as per W3C WebSockets specs.

*

* @return Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'

*/

public abstract int getReadyState();

}