io.netty.handler.pcap

类 PcapWriteHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.pcap.PcapWriteHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, java.io.Closeable, java.lang.AutoCloseable

public final class PcapWriteHandler
extends ChannelDuplexHandler
implements java.io.Closeable

PcapWriteHandler captures ByteBuf from SocketChannel / ServerChannel or DatagramPacket and writes it into Pcap OutputStream.

Things to keep in mind when using PcapWriteHandler with TCP:

• Whenever ChannelInboundHandlerAdapter.channelActive(ChannelHandlerContext) is called, a fake TCP 3-way handshake (SYN, SYN+ACK, ACK) is simulated as new connection in Pcap.
• Whenever ChannelHandlerAdapter.handlerRemoved(ChannelHandlerContext) is called, a fake TCP 3-way handshake (FIN+ACK, FIN+ACK, ACK) is simulated as connection shutdown in Pcap.
• Whenever ChannelInboundHandlerAdapter.exceptionCaught(ChannelHandlerContext, Throwable) is called, a fake TCP RST is sent to simulate connection Reset in Pcap.
• ACK is sent each time data is send / received.
• Zero Length Data Packets can cause TCP Double ACK error in Wireshark. To tackle this, set captureZeroByte to false.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	PcapWriteHandler.Builder Builder for PcapWriteHandler

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
PcapWriteHandler(java.io.OutputStream outputStream) 已过时。 Use PcapWriteHandler.Builder instead.
PcapWriteHandler(java.io.OutputStream outputStream, boolean captureZeroByte, boolean writePcapGlobalHeader) 已过时。 Use PcapWriteHandler.Builder instead.

方法概要

限定符和类型	方法和说明
static PcapWriteHandler.Builder	builder()
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	close() Close PcapWriter and OutputStream.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
boolean	isWriting() Returns true if the PcapWriteHandler is currently writing packets to the OutputStream else returns false.
void	pause() Pause the PcapWriteHandler from writing packets to the OutputStream.
void	resume() Resume the PcapWriteHandler to writing packets to the OutputStream.
java.lang.String	toString()
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
static void	writeGlobalHeader(java.io.OutputStream outputStream) Writes the Pcap Global Header to the provided OutputStream

从类继承的方法 io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded

构造器详细资料

PcapWriteHandler

@Deprecated
public PcapWriteHandler(java.io.OutputStream outputStream)

已过时。 Use PcapWriteHandler.Builder instead.

Create new PcapWriteHandler Instance. captureZeroByte is set to false and writePcapGlobalHeader is set to true.

参数:

outputStream - OutputStream where Pcap data will be written. Call close() to close this OutputStream.

抛出:

java.lang.NullPointerException - If OutputStream is null then we'll throw an NullPointerException

PcapWriteHandler

@Deprecated
public PcapWriteHandler(java.io.OutputStream outputStream,
                                     boolean captureZeroByte,
                                     boolean writePcapGlobalHeader)

已过时。 Use PcapWriteHandler.Builder instead.

Create new PcapWriteHandler Instance

参数:

outputStream - OutputStream where Pcap data will be written. Call close() to close this OutputStream.

captureZeroByte - Set to true to enable capturing packets with empty (0 bytes) payload. Otherwise, if set to false, empty packets will be filtered out.

writePcapGlobalHeader - Set to true to write Pcap Global Header on initialization. Otherwise, if set to false, Pcap Global Header will not be written on initialization. This could when writing Pcap data on a existing file where Pcap Global Header is already present.

抛出:

java.lang.NullPointerException - If OutputStream is null then we'll throw an NullPointerException

方法详细资料

writeGlobalHeader

public static void writeGlobalHeader(java.io.OutputStream outputStream)
                              throws java.io.IOException

Writes the Pcap Global Header to the provided OutputStream

参数:

outputStream - OutputStream where Pcap data will be written.

抛出:

java.io.IOException - if there is an error writing to the OutputStream

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelActive 在接口中 ChannelInboundHandler

覆盖:

channelActive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelRead

public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

exceptionCaught 在接口中 ChannelHandler

指定者:

exceptionCaught 在接口中 ChannelInboundHandler

覆盖:

exceptionCaught 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

isWriting

public boolean isWriting()

Returns true if the PcapWriteHandler is currently writing packets to the OutputStream else returns false.

pause

public void pause()

Pause the PcapWriteHandler from writing packets to the OutputStream.

resume

public void resume()

Resume the PcapWriteHandler to writing packets to the OutputStream.

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

close

public void close()
           throws java.io.IOException

Close PcapWriter and OutputStream.

Note: Calling this method does not close PcapWriteHandler. Only Pcap Writes are closed.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException - If OutputStream.close() throws an exception

builder

public static PcapWriteHandler.Builder builder()