pack-priv Class LoggingIOSession

Implements org.apache.hc.core5.reactor.IOSession.channel.

Doc from org.apache.hc.core5.reactor.IOSession.channel.

Returns the underlying I/O channel associated with this session.

Returns:ByteChannel

the I/O channel.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.clearEvent.

Doc from org.apache.hc.core5.reactor.IOSession.clearEvent.

Clears interest in a particular I/O event type by updating the event mask associated with the session.

Parameters

op:int

I/O event type.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.close.

Doc from org.apache.hc.core5.reactor.IOSession.close.

Terminates the session gracefully and closes the underlying I/O channel. This method ensures that session termination handshake, such as the one used by the SSL/TLS protocol, is correctly carried out.

Annotations

@Override

Implements org.apache.hc.core5.io.ModalCloseable.close.

Doc from org.apache.hc.core5.io.ModalCloseable.close.

Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.

Parameters

closeMode:CloseMode

How to close the receiver.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.enqueue.

Doc from org.apache.hc.core5.reactor.IOSession.enqueue.

Inserts Command at the end of the command queue.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getEventMask.

Doc from org.apache.hc.core5.reactor.IOSession.getEventMask.

Returns mask of I/O evens this session declared interest in.

Returns:int

I/O event mask.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getHandler.

Doc from org.apache.hc.core5.reactor.IOSession.getHandler.

Returns event handler associated with the session.

Annotations

@Override

Implements org.apache.hc.core5.util.Identifiable.getId.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getLastEventTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastEventTime.

Returns timestamp of the last I/O event including socket timeout reset.

Returns:long

timestamp.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getLastReadTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastReadTime.

Returns timestamp of the last read event.

Returns:long

timestamp.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getLastWriteTime.

Doc from org.apache.hc.core5.reactor.IOSession.getLastWriteTime.

Returns timestamp of the last write event.

Returns:long

timestamp.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getLocalAddress.

Doc from org.apache.hc.core5.reactor.IOSession.getLocalAddress.

Returns local address.

Returns:SocketAddress

socket address.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getLock.

Doc from org.apache.hc.core5.reactor.IOSession.getLock.

Returns session lock that should be used by I/O event handlers to synchronize access to the session.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getRemoteAddress.

Doc from org.apache.hc.core5.reactor.IOSession.getRemoteAddress.

Returns address of the remote peer.

Returns:SocketAddress

socket address.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getSocketTimeout.

Doc from org.apache.hc.core5.reactor.IOSession.getSocketTimeout.

Returns value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.

Returns:Timeout

socket timeout.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.getStatus.

Doc from org.apache.hc.core5.reactor.IOSession.getStatus.

Returns status of the session:

Status#ACTIVE: session is active.

Status#CLOSING: session is being closed.

Status#CLOSED: session has been terminated.

Returns:IOSession.Status

session status.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.hasCommands.

Doc from org.apache.hc.core5.reactor.IOSession.hasCommands.

Tests if there enqueued commands pending execution.

Annotations

@Override

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.poll.

Doc from org.apache.hc.core5.reactor.IOSession.poll.

Removes first Command from the command queue if available.

Annotations

@Override

Implements java.nio.channels.ReadableByteChannel.read.

Doc from java.nio.channels.ReadableByteChannel.read.

Reads a sequence of bytes from this channel into the given buffer.

An attempt is made to read up to r bytes from the channel, where r is the number of bytes remaining in the buffer, that is, dst.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is read, where 0 <= n <= r. This byte sequence will be transferred into the buffer so that the first byte in the sequence is at index p and the last byte is at index p + n - 1, where p is the buffer's position at the moment this method is invoked. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

A read operation might not fill the buffer, and in fact it might not read any bytes at all. Whether or not it does so depends upon the nature and state of the channel. A socket channel in non-blocking mode, for example, cannot read any more bytes than are immediately available from the socket's input buffer; similarly, a file channel cannot read any more bytes than remain in the file. It is guaranteed, however, that if a channel is in blocking mode and there is at least one byte remaining in the buffer then this method will block until at least one byte is read.

This method may be invoked at any time. If another thread has already initiated a read operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

dst:ByteBuffer

The buffer into which bytes are to be transferred

Returns:int

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs

Implements org.apache.hc.core5.reactor.IOSession.setEvent.

Doc from org.apache.hc.core5.reactor.IOSession.setEvent.

Declares interest in a particular I/O event type by updating the event mask associated with the session.

Parameters

op:int

I/O event type.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.setEventMask.

Doc from org.apache.hc.core5.reactor.IOSession.setEventMask.

Declares interest in I/O event notifications by setting the event mask associated with the session

Parameters

ops:int

new I/O event mask.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.setSocketTimeout.

Doc from org.apache.hc.core5.reactor.IOSession.setSocketTimeout.

Sets value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.

Please note this operation may affect the last event time.

Parameters

timeout:Timeout

socket timeout.

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.updateReadTime.

Doc from org.apache.hc.core5.reactor.IOSession.updateReadTime.

Updates the timestamp of the last read event

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.updateWriteTime.

Doc from org.apache.hc.core5.reactor.IOSession.updateWriteTime.

Updates the timestamp of the last write event

Annotations

@Override

Implements org.apache.hc.core5.reactor.IOSession.upgrade.

Doc from org.apache.hc.core5.reactor.IOSession.upgrade.

Upgrades event handler associated with the session.

Annotations

@Override

Implements java.nio.channels.WritableByteChannel.write.

Doc from java.nio.channels.WritableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, src.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

src:ByteBuffer

The buffer from which bytes are to be retrieved

Returns:int

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:

If some other I/O error occurs