FilesExpand file tree

 master

/

WebSocket.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

124 lines (98 loc) · 3.86 KB

 master

/

WebSocket.java

Copy path

Top

File metadata and controls

• Code
• Blame

124 lines (98 loc) · 3.86 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

115

116

117

118

119

120

121

122

123

124

package org.java_websocket;

import java.net.InetSocketAddress;

import java.nio.ByteBuffer;

import java.nio.channels.NotYetConnectedException;

import org.java_websocket.drafts.Draft;

import org.java_websocket.framing.Framedata;

import org.java_websocket.framing.Framedata.Opcode;

public interface WebSocket {

public enum Role {

CLIENT, SERVER

}

public enum READYSTATE {

NOT_YET_CONNECTED, CONNECTING, OPEN, CLOSING, CLOSED;

}

/**

* 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;

public static final int DEFAULT_WSS_PORT = 443;

/**

* sends the closing handshake.

* may be send in response to an other handshake.

*/

public void close( int code, String message );

public void close( int code );

/** Convenience function which behaves like close(CloseFrame.NORMAL) */

public void close();

/**

* This will close the connection immediately without a proper close handshake.

* The code and the message therefore won't be transfered over the wire also they will be forwarded to onClose/onWebsocketClose.

**/

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

/**

* Send Text data to the other end.

*

* @throws IllegalArgumentException

* @throws NotYetConnectedException

*/

public abstract void send( String text ) throws NotYetConnectedException;

/**

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

*

* @throws IllegalArgumentException

* @throws NotYetConnectedException

*/

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

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

public abstract void sendFrame( Framedata framedata );

/**

* Allows to send continuous/fragmented frames conveniently. <br>

* For more into on this frame type see http://tools.ietf.org/html/rfc6455#section-5.4<br>

*

* If the first frame you send is also the last then it is not a fragmented frame and will received via onMessage instead of onFragmented even though it was send by this method.

*

* @param op

* This is only important for the first frame in the sequence. Opcode.TEXT, Opcode.BINARY are allowed.

* @param buffer

* The buffer which contains the payload. It may have no bytes remaining.

* @param fin

* true means the current frame is the last in the sequence.

**/

public abstract void sendFragmentedFrame( Opcode op, ByteBuffer buffer, boolean fin );

public abstract boolean hasBufferedData();

/**

* @returns never returns null

*/

public abstract InetSocketAddress getRemoteSocketAddress();

/**

* @returns never returns null

*/

public abstract InetSocketAddress getLocalSocketAddress();

public abstract boolean isConnecting();

public abstract boolean isOpen();

public abstract boolean isClosing();

/**

* Returns true when no further frames may be submitted<br>

* This happens before the socket connection is closed.

*/

public abstract boolean isFlushAndClose();

/** Returns whether the close handshake has been completed and the socket is closed. */

public abstract boolean isClosed();

public abstract Draft getDraft();

/**

* 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 READYSTATE getReadyState();

/**

* Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2<br>

* If the opening handshake has not yet happened it will return null.

**/

public abstract String getResourceDescriptor();

}