Modifier and Type	Class and Description
public static class	PcapWriteHandler.Builder Builder for `PcapWriteHandler`
private static enum	PcapWriteHandler.ChannelType
private static class	PcapWriteHandler.WildcardAddressHolder

Modifier and Type	Field and Description
private final boolean	captureZeroByte `true` if we want to capture packets with zero bytes else `false`.
private PcapWriteHandler.ChannelType	channelType Type of the channel this handler is registered on
private InetSocketAddress	handlerAddr Address of the receiver of the connection
private InetSocketAddress	initiatorAddr Address of the initiator of the connection
private boolean	isServerPipeline Set to `true` if this handler is registered on a server pipeline
private final InternalLogger	logger Logger for logging events
private final OutputStream	outputStream `OutputStream` where we'll write Pcap data.
private PcapWriter	pCapWriter `PcapWriter` Instance
private int	receiveSegmentNumber TCP Receiver Segment Number.
private int	sendSegmentNumber TCP Sender Segment Number.
private final boolean	sharedOutputStream `true` if we want to synchronize on the `OutputStream` while writing else `false`.
private final AtomicReference<State>	state Current of this `PcapWriteHandler`
private final boolean	writePcapGlobalHeader `true` if we want to write Pcap Global Header on initialization of `PcapWriter` else `false`.

Access	Constructor and Description
public	PcapWriteHandler(OutputStream OutputStream where Pcap data will be written. Call `close()` to close this OutputStream. outputStream) Deprecated Use `Builder` instead. Create new `PcapWriteHandler` Instance.
public	PcapWriteHandler(OutputStream OutputStream where Pcap data will be written. Call `close()` to close this OutputStream. outputStream, boolean Set to `true` to enable capturing packets with empty (0 bytes) payload. Otherwise, if set to `false`, empty packets will be filtered out. captureZeroByte, boolean 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. writePcapGlobalHeader) Deprecated Use `Builder` instead. Create new `PcapWriteHandler` Instance
private	PcapWriteHandler(PcapWriteHandler.Builder builder, OutputStream outputStream)

Method Summary

Modifier and Type	Method and Description
public static PcapWriteHandler.Builder	builder()
public void	channelActive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	close() Implements java.io.Closeable.close. Close `PcapWriter` and `OutputStream`.
private void	completeTCPWrite(InetSocketAddress `InetSocketAddress` Source Address of this Packet srcAddr, InetSocketAddress `InetSocketAddress` Destination Address of this Packet dstAddr, ByteBuf `ByteBuf` containing TCP L4 Data tcpBuf, ByteBufAllocator `ByteBufAllocator` for allocating bytes for TCP/IP L3 and L2 data. byteBufAllocator, ChannelHandlerContext `ChannelHandlerContext` for `fireExceptionCaught` ctx) Write TCP/IP L3 and L2 here.
private void	completeUDPWrite(InetSocketAddress `InetSocketAddress` Source Address of this Packet srcAddr, InetSocketAddress `InetSocketAddress` Destination Address of this Packet dstAddr, ByteBuf `ByteBuf` containing UDP L4 Data udpBuf, ByteBufAllocator `ByteBufAllocator` for allocating bytes for UDP/IP L3 and L2 data. byteBufAllocator, ChannelHandlerContext `ChannelHandlerContext` for `fireExceptionCaught` ctx) Write UDP/IP L3 and L2 here.
public void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Gets called if a `Throwable` was thrown.
private static InetSocketAddress	Returns: The fixed local address getLocalAddress(Channel The channel to get the local address from ch, InetSocketAddress The remote address remote) Get the local address of a channel.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
private void	handleTCP(ChannelHandlerContext `ChannelHandlerContext` for `ByteBuf` allocation and `fireExceptionCaught` ctx, Object `Object` must be `ByteBuf` else it'll be discarded msg, boolean Set `true` if we have to process packet when packets are being sent out else set `false` isWriteOperation) Handle TCP L4
private void	handleUDP(ChannelHandlerContext `ChannelHandlerContext` for `localAddress` / `remoteAddress`, `ByteBuf` allocation and `fireExceptionCaught` ctx, Object `DatagramPacket` or `ByteBuf` msg) Handle UDP l4
private void	initializeIfNecessary(ChannelHandlerContext ctx)
public boolean	isWriting() Returns `true` if the `PcapWriteHandler` is currently writing packets to the `OutputStream` else returns `false`.
private void	logDiscard()
private void	logTCP(boolean isWriteOperation, int bytes, int sendSegmentNumber, int receiveSegmentNumber, InetSocketAddress srcAddr, InetSocketAddress dstAddr, boolean ackOnly) Logger for TCP
pack-priv void	markClosed()
pack-priv OutputStream	outputStream()
public void	pause() Pause the `PcapWriteHandler` from writing packets to the `OutputStream`.
pack-priv PcapWriter	pCapWriter()
public void	resume() Resume the `PcapWriteHandler` to writing packets to the `OutputStream`.
pack-priv boolean	sharedOutputStream()
pack-priv State	state()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public static void	writeGlobalHeader(OutputStream OutputStream where Pcap data will be written. outputStream) Writes the Pcap Global Header to the provided `OutputStream`

Inherited from io.netty.channel.ChannelDuplexHandler:: bind close connect deregister disconnect flush read

Field Detail

captureZeroByte	back to summary
private final boolean captureZeroByte `true` if we want to capture packets with zero bytes else `false`.

channelType	back to summary
private PcapWriteHandler.ChannelType channelType Type of the channel this handler is registered on

handlerAddr	back to summary
private InetSocketAddress handlerAddr Address of the receiver of the connection

initiatorAddr	back to summary
private InetSocketAddress initiatorAddr Address of the initiator of the connection

isServerPipeline	back to summary
private boolean isServerPipeline Set to `true` if this handler is registered on a server pipeline

logger	back to summary
private final InternalLogger logger Logger for logging events

outputStream	back to summary
private final OutputStream outputStream `OutputStream` where we'll write Pcap data.

pCapWriter	back to summary
private PcapWriter pCapWriter `PcapWriter` Instance

receiveSegmentNumber	back to summary
private int receiveSegmentNumber TCP Receiver Segment Number. It'll start with 1 and keep incrementing with number of bytes read/sent.

sendSegmentNumber	back to summary
private int sendSegmentNumber TCP Sender Segment Number. It'll start with 1 and keep incrementing with number of bytes read/sent.

sharedOutputStream	back to summary
private final boolean sharedOutputStream `true` if we want to synchronize on the `OutputStream` while writing else `false`.

state	back to summary
private final AtomicReference<State> state Current of this `PcapWriteHandler`

writePcapGlobalHeader	back to summary
private final boolean writePcapGlobalHeader `true` if we want to write Pcap Global Header on initialization of `PcapWriter` else `false`.

Constructor Detail

PcapWriteHandler back to summary

PcapWriteHandler	back to summary
public PcapWriteHandler(OutputStream outputStream) Deprecated Use `Builder` instead. Create new `PcapWriteHandler` Instance. `captureZeroByte` is set to `false` and `writePcapGlobalHeader` is set to `true`. Parameters outputStream:OutputStream OutputStream where Pcap data will be written. Call `close()` to close this OutputStream. Annotations @Deprecated Exceptions NullPointerException: If `OutputStream` is `null` then we'll throw an `NullPointerException`

public PcapWriteHandler(OutputStream outputStream)

Deprecated

Use Builder instead.

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

Parameters

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

Annotations

@Deprecated

Exceptions

NullPointerException:: If OutputStream is null then we'll throw an NullPointerException

PcapWriteHandler back to summary

PcapWriteHandler	back to summary
public PcapWriteHandler(OutputStream outputStream, boolean captureZeroByte, boolean writePcapGlobalHeader) Deprecated Use `Builder` instead. Create new `PcapWriteHandler` Instance Parameters outputStream:OutputStream OutputStream where Pcap data will be written. Call `close()` to close this OutputStream. captureZeroByte:boolean Set to `true` to enable capturing packets with empty (0 bytes) payload. Otherwise, if set to `false`, empty packets will be filtered out. writePcapGlobalHeader:boolean 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. Annotations @Deprecated Exceptions NullPointerException: If `OutputStream` is `null` then we'll throw an `NullPointerException`

public PcapWriteHandler(OutputStream outputStream, boolean captureZeroByte, boolean writePcapGlobalHeader)

Deprecated

Use Builder instead.

Create new PcapWriteHandler Instance

Parameters

outputStream:OutputStream: OutputStream where Pcap data will be written. Call close() to close this OutputStream.
captureZeroByte:boolean: Set to true to enable capturing packets with empty (0 bytes) payload. Otherwise, if set to false, empty packets will be filtered out.
writePcapGlobalHeader:boolean: 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.

Annotations

@Deprecated

Exceptions

NullPointerException:: If OutputStream is null then we'll throw an NullPointerException

PcapWriteHandler	back to summary
private PcapWriteHandler(PcapWriteHandler.Builder builder, OutputStream outputStream)

Method Detail

builder	back to summary
public static PcapWriteHandler.Builder builder()

channelActive back to summary

channelActive	back to summary
public void channelActive(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelActive(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive.

Implements io.netty.channel.ChannelInboundHandler.channelActive.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelActive.

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

Annotations

@Override

channelRead back to summary

channelRead	back to summary
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

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

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Implements io.netty.channel.ChannelInboundHandler.channelRead.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

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

Annotations

@Override

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Close `PcapWriter` and `OutputStream`. Note Calling this method does not close `PcapWriteHandler`. Only Pcap Writes are closed. Annotations @Override Exceptions IOException: If `OutputStream#close()` throws an exception

public void close() throws IOException

Implements java.io.Closeable.close.

Close PcapWriter and OutputStream.

Note

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

Annotations

@Override

Exceptions

IOException:: If OutputStream#close() throws an exception

completeTCPWrite back to summary

completeTCPWrite	back to summary
private void completeTCPWrite(InetSocketAddress srcAddr, InetSocketAddress dstAddr, ByteBuf tcpBuf, ByteBufAllocator byteBufAllocator, ChannelHandlerContext ctx) Write TCP/IP L3 and L2 here. Parameters srcAddr:InetSocketAddress `InetSocketAddress` Source Address of this Packet dstAddr:InetSocketAddress `InetSocketAddress` Destination Address of this Packet tcpBuf:ByteBuf `ByteBuf` containing TCP L4 Data byteBufAllocator:ByteBufAllocator `ByteBufAllocator` for allocating bytes for TCP/IP L3 and L2 data. ctx:ChannelHandlerContext `ChannelHandlerContext` for `fireExceptionCaught`

private void completeTCPWrite(InetSocketAddress srcAddr, InetSocketAddress dstAddr, ByteBuf tcpBuf, ByteBufAllocator byteBufAllocator, ChannelHandlerContext ctx)

Write TCP/IP L3 and L2 here.

Parameters

srcAddr:InetSocketAddress: InetSocketAddress Source Address of this Packet
dstAddr:InetSocketAddress: InetSocketAddress Destination Address of this Packet
tcpBuf:ByteBuf: ByteBuf containing TCP L4 Data
byteBufAllocator:ByteBufAllocator: ByteBufAllocator for allocating bytes for TCP/IP L3 and L2 data.
ctx:ChannelHandlerContext: ChannelHandlerContext for fireExceptionCaught

completeUDPWrite back to summary

completeUDPWrite	back to summary
private void completeUDPWrite(InetSocketAddress srcAddr, InetSocketAddress dstAddr, ByteBuf udpBuf, ByteBufAllocator byteBufAllocator, ChannelHandlerContext ctx) Write UDP/IP L3 and L2 here. Parameters srcAddr:InetSocketAddress `InetSocketAddress` Source Address of this Packet dstAddr:InetSocketAddress `InetSocketAddress` Destination Address of this Packet udpBuf:ByteBuf `ByteBuf` containing UDP L4 Data byteBufAllocator:ByteBufAllocator `ByteBufAllocator` for allocating bytes for UDP/IP L3 and L2 data. ctx:ChannelHandlerContext `ChannelHandlerContext` for `fireExceptionCaught`

private void completeUDPWrite(InetSocketAddress srcAddr, InetSocketAddress dstAddr, ByteBuf udpBuf, ByteBufAllocator byteBufAllocator, ChannelHandlerContext ctx)

Write UDP/IP L3 and L2 here.

Parameters

srcAddr:InetSocketAddress: InetSocketAddress Source Address of this Packet
dstAddr:InetSocketAddress: InetSocketAddress Destination Address of this Packet
udpBuf:ByteBuf: ByteBuf containing UDP L4 Data
byteBufAllocator:ByteBufAllocator: ByteBufAllocator for allocating bytes for UDP/IP L3 and L2 data.
ctx:ChannelHandlerContext: ChannelHandlerContext for fireExceptionCaught

exceptionCaught back to summary

exceptionCaught	back to summary
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Doc from io.netty.channel.ChannelHandler.exceptionCaught. Gets called if a `Throwable` was thrown. Annotations @Override

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

Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught.

Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught.

Doc from io.netty.channel.ChannelHandler.exceptionCaught.

Gets called if a Throwable was thrown.

Annotations

@Override

getLocalAddress back to summary

getLocalAddress	back to summary
private static InetSocketAddress getLocalAddress(Channel ch, InetSocketAddress remote) Get the local address of a channel. If the address is a wildcard address (`0.0.0.0` or `::`), and the address family does not match that of the `remote`, return the wildcard address of the `remote`'s family instead. Parameters ch:Channel The channel to get the local address from remote:InetSocketAddress The remote address Returns:InetSocketAddress The fixed local address

private static InetSocketAddress getLocalAddress(Channel ch, InetSocketAddress remote)

Get the local address of a channel. If the address is a wildcard address (0.0.0.0 or ::), and the address family does not match that of the remote, return the wildcard address of the remote's family instead.

Parameters

ch:Channel: The channel to get the local address from
remote:InetSocketAddress: The remote address

Returns:InetSocketAddress

The fixed local address

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Doc from io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Doc from io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

handleTCP back to summary

handleTCP	back to summary
private void handleTCP(ChannelHandlerContext ctx, Object msg, boolean isWriteOperation) Handle TCP L4 Parameters ctx:ChannelHandlerContext `ChannelHandlerContext` for `ByteBuf` allocation and `fireExceptionCaught` msg:Object `Object` must be `ByteBuf` else it'll be discarded isWriteOperation:boolean Set `true` if we have to process packet when packets are being sent out else set `false`

private void handleTCP(ChannelHandlerContext ctx, Object msg, boolean isWriteOperation)

Handle TCP L4

Parameters

ctx:ChannelHandlerContext: ChannelHandlerContext for ByteBuf allocation and fireExceptionCaught
msg:Object: Object must be ByteBuf else it'll be discarded
isWriteOperation:boolean: Set true if we have to process packet when packets are being sent out else set false

handleUDP back to summary

handleUDP	back to summary
private void handleUDP(ChannelHandlerContext ctx, Object msg) Handle UDP l4 Parameters ctx:ChannelHandlerContext `ChannelHandlerContext` for `localAddress` / `remoteAddress`, `ByteBuf` allocation and `fireExceptionCaught` msg:Object `DatagramPacket` or `ByteBuf`

private void handleUDP(ChannelHandlerContext ctx, Object msg)

Handle UDP l4

Parameters

ctx:ChannelHandlerContext: ChannelHandlerContext for localAddress / remoteAddress, ByteBuf allocation and fireExceptionCaught
msg:Object: DatagramPacket or ByteBuf

initializeIfNecessary	back to summary
private void initializeIfNecessary(ChannelHandlerContext ctx) throws Exception

isWriting	back to summary
public boolean isWriting() Returns `true` if the `PcapWriteHandler` is currently writing packets to the `OutputStream` else returns `false`.

logDiscard	back to summary
private void logDiscard()

logTCP	back to summary
private void logTCP(boolean isWriteOperation, int bytes, int sendSegmentNumber, int receiveSegmentNumber, InetSocketAddress srcAddr, InetSocketAddress dstAddr, boolean ackOnly) Logger for TCP

markClosed	back to summary
pack-priv void markClosed()

outputStream	back to summary
pack-priv OutputStream outputStream()

pause	back to summary
public void pause() Pause the `PcapWriteHandler` from writing packets to the `OutputStream`.

pCapWriter	back to summary
pack-priv PcapWriter pCapWriter()

resume	back to summary
public void resume() Resume the `PcapWriteHandler` to writing packets to the `OutputStream`.

sharedOutputStream	back to summary
pack-priv boolean sharedOutputStream()

state	back to summary
pack-priv State state()

toString	back to summary
public String toString() 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

toString

back to summary

public String toString()

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

write back to summary

write	back to summary
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Doc from io.netty.channel.ChannelDuplexHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Parameters ctx:ChannelHandlerContext Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelHandlerContext` for which the write operation is made msg:Object Doc from io.netty.channel.ChannelOutboundHandler.write. the message to write promise:ChannelPromise Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: Doc from io.netty.channel.ChannelOutboundHandler.write. thrown if an error occurs

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

Overrides io.netty.channel.ChannelDuplexHandler.write.

Implements io.netty.channel.ChannelOutboundHandler.write.

Doc from io.netty.channel.ChannelDuplexHandler.write.

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

Parameters

ctx:ChannelHandlerContext

Doc from io.netty.channel.ChannelOutboundHandler.write.

the ChannelHandlerContext for which the write operation is made

msg:Object

Doc from io.netty.channel.ChannelOutboundHandler.write.

the message to write

promise:ChannelPromise

Doc from io.netty.channel.ChannelOutboundHandler.write.

the ChannelPromise to notify once the operation completes

Annotations

@Override

Exceptions

Exception:

Doc from io.netty.channel.ChannelOutboundHandler.write.

thrown if an error occurs

writeGlobalHeader back to summary

writeGlobalHeader	back to summary
public static void writeGlobalHeader(OutputStream outputStream) throws IOException Writes the Pcap Global Header to the provided `OutputStream` Parameters outputStream:OutputStream OutputStream where Pcap data will be written. Exceptions IOException: if there is an error writing to the `OutputStream`

public static void writeGlobalHeader(OutputStream outputStream) throws IOException

Writes the Pcap Global Header to the provided OutputStream

Parameters

outputStream:OutputStream: OutputStream where Pcap data will be written.

Exceptions

IOException:: if there is an error writing to the OutputStream

io.netty.handler.pcap back to summary

public final Class PcapWriteHandler.Builder

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.pcap.PcapWriteHandler.Builder

Builder for PcapWriteHandler

Field Summary

Modifier and Type	Field and Description
private boolean	captureZeroByte
private PcapWriteHandler.ChannelType	channelType
private InetSocketAddress	handlerAddr
private InetSocketAddress	initiatorAddr
private boolean	isServerPipeline
private boolean	sharedOutputStream
private boolean	writePcapGlobalHeader

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public PcapWriteHandler	Returns: The handler. build(OutputStream The output stream to write the pcap data to. outputStream) Build the `PcapWriteHandler`.
public PcapWriteHandler.Builder	Returns: this builder captureZeroByte(boolean Whether to filter out empty packets. captureZeroByte) Set to `true` to enable capturing packets with empty (0 bytes) payload.
public PcapWriteHandler.Builder	Returns: this builder forceTcpChannel(InetSocketAddress The address of the TCP server (handler) serverAddress, InetSocketAddress The address of the TCP client (initiator) clientAddress, boolean Whether the handler is part of the server channel isServerPipeline) Force this handler to write data as if they were TCP packets, with the given connection metadata.
public PcapWriteHandler.Builder	Returns: this builder forceUdpChannel(InetSocketAddress The address of the UDP local localAddress, InetSocketAddress The address of the UDP remote remoteAddress) Force this handler to write data as if they were UDP packets, with the given connection metadata.
public PcapWriteHandler.Builder	Returns: this builder sharedOutputStream(boolean Whether `OutputStream` is shared or not sharedOutputStream) Set to `true` if multiple `PcapWriteHandler` instances will be writing to the same `OutputStream` concurrently, and write locking is required.
public PcapWriteHandler.Builder	Returns: this builder writePcapGlobalHeader(boolean Whether to write the pcap global header. writePcapGlobalHeader) Set to `true` to write Pcap Global Header on initialization.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

captureZeroByte	back to summary
private boolean captureZeroByte

channelType	back to summary
private PcapWriteHandler.ChannelType channelType

handlerAddr	back to summary
private InetSocketAddress handlerAddr

initiatorAddr	back to summary
private InetSocketAddress initiatorAddr

isServerPipeline	back to summary
private boolean isServerPipeline

sharedOutputStream	back to summary
private boolean sharedOutputStream

writePcapGlobalHeader	back to summary
private boolean writePcapGlobalHeader

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build back to summary

public PcapWriteHandler build(OutputStream outputStream)

Build the PcapWriteHandler.

Parameters

outputStream:OutputStream: The output stream to write the pcap data to.

Returns:PcapWriteHandler

The handler.

captureZeroByte back to summary

public PcapWriteHandler.Builder captureZeroByte(boolean captureZeroByte)

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

Parameters

captureZeroByte:boolean: Whether to filter out empty packets.

Returns:PcapWriteHandler.Builder

this builder

forceTcpChannel

back to summary

public PcapWriteHandler.Builder forceTcpChannel(InetSocketAddress serverAddress, InetSocketAddress clientAddress, boolean isServerPipeline)

Force this handler to write data as if they were TCP packets, with the given connection metadata. If this method isn't called, we determine the metadata from the channel.

Parameters

serverAddress:InetSocketAddress: The address of the TCP server (handler)
clientAddress:InetSocketAddress: The address of the TCP client (initiator)
isServerPipeline:boolean: Whether the handler is part of the server channel

Returns:PcapWriteHandler.Builder

this builder

forceUdpChannel back to summary

public PcapWriteHandler.Builder forceUdpChannel(InetSocketAddress localAddress, InetSocketAddress remoteAddress)

Force this handler to write data as if they were UDP packets, with the given connection metadata. If this method isn't called, we determine the metadata from the channel.
Note that even if this method is called, the address information on DatagramPacket takes precedence if it is present.

Parameters

localAddress:InetSocketAddress: The address of the UDP local
remoteAddress:InetSocketAddress: The address of the UDP remote

Returns:PcapWriteHandler.Builder

this builder

sharedOutputStream back to summary

public PcapWriteHandler.Builder sharedOutputStream(boolean sharedOutputStream)

Set to true if multiple PcapWriteHandler instances will be writing to the same OutputStream concurrently, and write locking is required. Otherwise, if set to false, no locking will be done. Additionally, close will not close the underlying OutputStream.

Note

it is probably an error to have both writePcapGlobalHeader and sharedOutputStream set to true at the same time.

Parameters

sharedOutputStream:boolean: Whether OutputStream is shared or not

Returns:PcapWriteHandler.Builder

this builder

writePcapGlobalHeader back to summary

public PcapWriteHandler.Builder writePcapGlobalHeader(boolean 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.

Parameters

writePcapGlobalHeader:boolean: Whether to write the pcap global header.

Returns:PcapWriteHandler.Builder

this builder

Modifier and Type	Method and Description
public static PcapWriteHandler.ChannelType	valueOf(String name)
public static PcapWriteHandler.ChannelType[]	values()

Modifier and Type	Field and Description
pack-priv static final InetAddress	wildcard4
pack-priv static final InetAddress	wildcard6

public final Class PcapWriteHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class PcapWriteHandler.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum PcapWriteHandler.ChannelType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PcapWriteHandler.WildcardAddressHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
public static final PcapWriteHandler.ChannelType	TCP
public static final PcapWriteHandler.ChannelType	UDP