org.java_websocket

类 SSLSocketChannel

java.lang.Object

org.java_websocket.SSLSocketChannel

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel, WrappedByteChannel

public class SSLSocketChannel
extends java.lang.Object
implements WrappedByteChannel, java.nio.channels.ByteChannel

A class that represents an SSL/TLS peer, and can be extended to create a client or a server. It makes use of the JSSE framework, and specifically the SSLEngine logic, which is described by Oracle as "an advanced API, not appropriate for casual use", since it requires the user to implement much of the communication establishment procedure himself. More information about it can be found here: http://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLEngine SSLSocketChannel implements the handshake protocol, required to establish a connection between two peers, which is common for both client and server and provides the abstract read(ByteBuffer) and write(ByteBuffer) (String)} methods, that need to be implemented by the specific SSL/TLS peer that is going to extend this class.

作者:

Alex Karnezis

Modified by marci4 to allow the usage as a ByteChannel

Permission for usage recieved at May 25, 2017 by Alex Karnezis

构造器概要

构造器

构造器和说明
SSLSocketChannel(java.nio.channels.SocketChannel inputSocketChannel, javax.net.ssl.SSLEngine inputEngine, java.util.concurrent.ExecutorService inputExecutor, java.nio.channels.SelectionKey key)

方法概要

限定符和类型	方法和说明
void	close()
boolean	isBlocking() This function returns the blocking state of the channel
boolean	isNeedRead() returns whether readMore should be called to fetch data which has been decoded but not yet been returned.
boolean	isNeedWrite() returns whether writeMore should be called write additional data.
boolean	isOpen()
int	read(java.nio.ByteBuffer dst)
int	readMore(java.nio.ByteBuffer dst) This function does not read data from the underlying channel at all.
int	write(java.nio.ByteBuffer output)
void	writeMore() Gets called when WrappedByteChannel.isNeedWrite() ()} requires a additional rite

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SSLSocketChannel

public SSLSocketChannel(java.nio.channels.SocketChannel inputSocketChannel,
                        javax.net.ssl.SSLEngine inputEngine,
                        java.util.concurrent.ExecutorService inputExecutor,
                        java.nio.channels.SelectionKey key)
                 throws java.io.IOException

抛出:

java.io.IOException

方法详细资料

read

public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException

指定者:

read 在接口中 java.nio.channels.ReadableByteChannel

抛出:

java.io.IOException

write

public int write(java.nio.ByteBuffer output)
          throws java.io.IOException

指定者:

write 在接口中 java.nio.channels.WritableByteChannel

抛出:

java.io.IOException

isNeedWrite

public boolean isNeedWrite()

从接口复制的说明: WrappedByteChannel

returns whether writeMore should be called write additional data.

指定者:

isNeedWrite 在接口中 WrappedByteChannel

返回:

is a additional write needed

writeMore

public void writeMore()
               throws java.io.IOException

从接口复制的说明: WrappedByteChannel

Gets called when WrappedByteChannel.isNeedWrite() ()} requires a additional rite

指定者:

writeMore 在接口中 WrappedByteChannel

抛出:

java.io.IOException - may be thrown due to an error while writing

isNeedRead

public boolean isNeedRead()

从接口复制的说明: WrappedByteChannel

returns whether readMore should be called to fetch data which has been decoded but not yet been returned.

指定者:

isNeedRead 在接口中 WrappedByteChannel

返回:

is a additional read needed

另请参阅:

ReadableByteChannel.read(ByteBuffer), WrappedByteChannel.readMore(ByteBuffer)

readMore

public int readMore(java.nio.ByteBuffer dst)
             throws java.io.IOException

从接口复制的说明: WrappedByteChannel

This function does not read data from the underlying channel at all. It is just a way to fetch data which has already be received or decoded but was but was not yet returned to the user. This could be the case when the decoded data did not fit into the buffer the user passed to ReadableByteChannel.read(ByteBuffer).

指定者:

readMore 在接口中 WrappedByteChannel

参数:

dst - the destiny of the read

返回:

the amount of remaining data

抛出:

java.io.IOException - when a error occurred during unwrapping

isBlocking

public boolean isBlocking()

从接口复制的说明: WrappedByteChannel

This function returns the blocking state of the channel

指定者:

isBlocking 在接口中 WrappedByteChannel

返回:

is the channel blocking

isOpen

public boolean isOpen()

指定者:

isOpen 在接口中 java.nio.channels.Channel

close

public void close()
           throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在接口中 java.nio.channels.Channel

抛出:

java.io.IOException