public interface GridNioFilter
Modifier and Type | Method and Description |
---|---|
GridNioFilter |
nextFilter()
Gets next filter in filter chain.
|
void |
nextFilter(GridNioFilter filter)
Sets next filter in filter chain.
|
void |
onExceptionCaught(GridNioSession ses,
IgniteCheckedException ex)
Invoked when exception is caught in filter processing.
|
void |
onMessageReceived(GridNioSession ses,
Object msg)
Invoked when a new messages received.
|
GridNioFuture<?> |
onPauseReads(GridNioSession ses)
Pauses reads for session.
|
GridNioFuture<?> |
onResumeReads(GridNioSession ses)
Resumes reads for session.
|
GridNioFuture<Boolean> |
onSessionClose(GridNioSession ses)
Invoked when a session close request is performed on session.
|
void |
onSessionClosed(GridNioSession ses)
Invoked after session get closed.
|
void |
onSessionIdleTimeout(GridNioSession ses)
Called when session is idle for longer time that is
allowed by NIO server.
|
void |
onSessionOpened(GridNioSession ses)
Invoked when a new session was created.
|
GridNioFuture<?> |
onSessionWrite(GridNioSession ses,
Object msg,
boolean fut,
IgniteInClosure<IgniteException> ackC)
Invoked when a write request is performed on a session.
|
void |
onSessionWriteTimeout(GridNioSession ses)
Called when session has not empty write buffer that has not been fully
flushed during max timeout allowed by NIO server.
|
GridNioFilter |
previousFilter()
Gets previous filter in filter chain.
|
void |
previousFilter(GridNioFilter filter)
Sets previous filter in filter chain.
|
void |
proceedExceptionCaught(GridNioSession ses,
IgniteCheckedException e)
Forwards GridNioException event to the next logical filter in filter chain.
|
void |
proceedMessageReceived(GridNioSession ses,
Object msg)
Forwards received message to the next logical filter in filter chain.
|
GridNioFuture<?> |
proceedPauseReads(GridNioSession ses)
Pauses reads for session.
|
GridNioFuture<?> |
proceedResumeReads(GridNioSession ses)
Resumes reads for session.
|
GridNioFuture<Boolean> |
proceedSessionClose(GridNioSession ses)
Forwards session close request to the next logical filter in filter chain.
|
void |
proceedSessionClosed(GridNioSession ses)
Forwards session closed event to the next logical filter in filter chain.
|
void |
proceedSessionIdleTimeout(GridNioSession ses)
Forwards session idle notification to the next logical filter in filter chain.
|
void |
proceedSessionOpened(GridNioSession ses)
Forwards session opened event to the next logical filter in filter chain.
|
GridNioFuture<?> |
proceedSessionWrite(GridNioSession ses,
Object msg,
boolean fut,
IgniteInClosure<IgniteException> ackC)
Forwards write request to the next logical filter in filter chain.
|
void |
proceedSessionWriteTimeout(GridNioSession ses)
Forwards session write timeout notification to the next logical filter in filter chain.
|
void |
start()
Beginning of a filter lifecycle, invoked on server start.
|
void |
stop()
End of a filter lifecycle, invoked on server stop.
|
void start()
void stop()
GridNioFilter nextFilter()
GridNioFilter previousFilter()
void nextFilter(GridNioFilter filter)
filter
- Next filter in filter chain.void previousFilter(GridNioFilter filter)
filter
- Previous filter in filter chain.void proceedSessionOpened(GridNioSession ses) throws IgniteCheckedException
ses
- Opened session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void proceedSessionClosed(GridNioSession ses) throws IgniteCheckedException
ses
- Closed session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void proceedExceptionCaught(GridNioSession ses, IgniteCheckedException e) throws IgniteCheckedException
ses
- Session instance.e
- GridNioException instance.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void proceedMessageReceived(GridNioSession ses, Object msg) throws IgniteCheckedException
ses
- Session instance.msg
- Received message.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<?> proceedSessionWrite(GridNioSession ses, Object msg, boolean fut, IgniteInClosure<IgniteException> ackC) throws IgniteCheckedException
ses
- Session instance.msg
- Message to send.fut
- True
if write future should be created.ackC
- Closure invoked when message ACK is received.null
.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<Boolean> proceedSessionClose(GridNioSession ses) throws IgniteCheckedException
ses
- Session instance.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void onSessionOpened(GridNioSession ses) throws IgniteCheckedException
ses
- Opened session.IgniteCheckedException
- If GridNioException occurred while handling event.void onSessionClosed(GridNioSession ses) throws IgniteCheckedException
ses
- Closed session.IgniteCheckedException
- If GridNioException occurred while handling event.void onExceptionCaught(GridNioSession ses, IgniteCheckedException ex) throws IgniteCheckedException
ses
- Session that caused IgniteCheckedException.ex
- GridNioException instance.IgniteCheckedException
- If IgniteCheckedException occurred while handling event.GridNioFuture<?> onSessionWrite(GridNioSession ses, Object msg, boolean fut, IgniteInClosure<IgniteException> ackC) throws IgniteCheckedException
ses
- Session on which message should be written.msg
- Message being written.fut
- True
if write future should be created.ackC
- Closure invoked when message ACK is received.null
.GridNioException
- If GridNioException occurred while handling event.IgniteCheckedException
void onMessageReceived(GridNioSession ses, Object msg) throws IgniteCheckedException
ses
- Session on which message was received.msg
- Received message.IgniteCheckedException
- If IgniteCheckedException occurred while handling event.GridNioFuture<Boolean> onSessionClose(GridNioSession ses) throws IgniteCheckedException
ses
- Session to close.IgniteCheckedException
- If IgniteCheckedException occurred while handling event.void onSessionIdleTimeout(GridNioSession ses) throws IgniteCheckedException
ses
- Session that is idle.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void proceedSessionIdleTimeout(GridNioSession ses) throws IgniteCheckedException
ses
- Session instance.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void onSessionWriteTimeout(GridNioSession ses) throws IgniteCheckedException
ses
- Session that has timed out writes.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.void proceedSessionWriteTimeout(GridNioSession ses) throws IgniteCheckedException
ses
- Session instance.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<?> proceedPauseReads(GridNioSession ses) throws IgniteCheckedException
ses
- Session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<?> onPauseReads(GridNioSession ses) throws IgniteCheckedException
ses
- Session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<?> proceedResumeReads(GridNioSession ses) throws IgniteCheckedException
ses
- Session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.GridNioFuture<?> onResumeReads(GridNioSession ses) throws IgniteCheckedException
ses
- Session.IgniteCheckedException
- If filter is not in chain or GridNioException occurred in the underlying filter.
Follow @ApacheIgnite
Ignite Fabric : ver. 2.0.0 Release Date : April 30 2017