public final class PcapWriteHandler extends io.netty.channel.ChannelDuplexHandler implements 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:
ChannelInboundHandlerAdapter.channelActive(ChannelHandlerContext)
is called,
a fake TCP 3-way handshake (SYN, SYN+ACK, ACK) is simulated as new connection in Pcap. ChannelHandlerAdapter.handlerRemoved(ChannelHandlerContext)
is called,
a fake TCP 3-way handshake (FIN+ACK, FIN+ACK, ACK) is simulated as connection shutdown in Pcap. ChannelInboundHandlerAdapter.exceptionCaught(ChannelHandlerContext, Throwable)
is called, a fake TCP RST is sent to simulate connection Reset in Pcap. captureZeroByte
to false
. Modifier and Type | Class and Description |
---|---|
static class |
PcapWriteHandler.Builder
Builder for
PcapWriteHandler |
Constructor and Description |
---|
PcapWriteHandler(OutputStream outputStream)
Deprecated.
Use
PcapWriteHandler.Builder instead. |
PcapWriteHandler(OutputStream outputStream,
boolean captureZeroByte,
boolean writePcapGlobalHeader)
Deprecated.
Use
PcapWriteHandler.Builder instead. |
Modifier and Type | Method and Description |
---|---|
static PcapWriteHandler.Builder |
builder() |
void |
channelActive(io.netty.channel.ChannelHandlerContext ctx) |
void |
channelRead(io.netty.channel.ChannelHandlerContext ctx,
Object msg) |
void |
close()
Close
PcapWriter and OutputStream . |
void |
exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
Throwable cause) |
void |
handlerRemoved(io.netty.channel.ChannelHandlerContext ctx) |
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 . |
String |
toString() |
void |
write(io.netty.channel.ChannelHandlerContext ctx,
Object msg,
io.netty.channel.ChannelPromise promise) |
static void |
writeGlobalHeader(OutputStream outputStream)
Writes the Pcap Global Header to the provided
OutputStream |
bind, close, connect, deregister, disconnect, flush, read
channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
ensureNotSharable, handlerAdded, isSharable
@Deprecated public PcapWriteHandler(OutputStream outputStream)
PcapWriteHandler.Builder
instead.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.NullPointerException
- If OutputStream
is null
then we'll throw an
NullPointerException
@Deprecated public PcapWriteHandler(OutputStream outputStream, boolean captureZeroByte, boolean writePcapGlobalHeader)
PcapWriteHandler.Builder
instead.PcapWriteHandler
InstanceoutputStream
- 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.NullPointerException
- If OutputStream
is null
then we'll throw an
NullPointerException
public static void writeGlobalHeader(OutputStream outputStream) throws IOException
OutputStream
outputStream
- OutputStream where Pcap data will be written.IOException
- if there is an error writing to the OutputStream
public void channelActive(io.netty.channel.ChannelHandlerContext ctx) throws Exception
channelActive
in interface io.netty.channel.ChannelInboundHandler
channelActive
in class io.netty.channel.ChannelInboundHandlerAdapter
Exception
public void channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg) throws Exception
channelRead
in interface io.netty.channel.ChannelInboundHandler
channelRead
in class io.netty.channel.ChannelInboundHandlerAdapter
Exception
public void write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise) throws Exception
write
in interface io.netty.channel.ChannelOutboundHandler
write
in class io.netty.channel.ChannelDuplexHandler
Exception
public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx) throws Exception
handlerRemoved
in interface io.netty.channel.ChannelHandler
handlerRemoved
in class io.netty.channel.ChannelHandlerAdapter
Exception
public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause) throws Exception
exceptionCaught
in interface io.netty.channel.ChannelHandler
exceptionCaught
in interface io.netty.channel.ChannelInboundHandler
exceptionCaught
in class io.netty.channel.ChannelInboundHandlerAdapter
Exception
public boolean isWriting()
true
if the PcapWriteHandler
is currently
writing packets to the OutputStream
else returns false
.public void pause()
PcapWriteHandler
from writing packets to the OutputStream
.public void resume()
PcapWriteHandler
to writing packets to the OutputStream
.public void close() throws IOException
Close PcapWriter
and OutputStream
.
Note: Calling this method does not close PcapWriteHandler
.
Only Pcap Writes are closed.
close
in interface Closeable
close
in interface AutoCloseable
IOException
- If OutputStream.close()
throws an exceptionpublic static PcapWriteHandler.Builder builder()
Copyright © 2008–2023 The Netty Project. All rights reserved.