RTI Connext Java API
Version 6.1.2
|
Network Capture APIs. More...
Static Public Member Functions | |
static native boolean | enable () |
Enable Network Capture. More... | |
static native boolean | disable () |
Disable Network Capture. More... | |
static boolean | set_default_params (NetworkCaptureParams params) |
Set the default Network Capture parameters. More... | |
static native boolean | start (String filename) |
Start capturing traffic for all DomainParticipants, with the default parameters. More... | |
static boolean | start (DomainParticipant participant, String filename) |
Start capturing traffic for a DomainParticipant, with the default parameters. More... | |
static boolean | start (String filename, NetworkCaptureParams params) |
Start capturing traffic for all DomainParticipants, with the provided parameters. More... | |
static boolean | start (DomainParticipant participant, String filename, NetworkCaptureParams params) |
Start capturing traffic for a DomainParticipant, with the provided parameters. More... | |
static native boolean | stop () |
Stop capturing traffic for all participants. More... | |
static boolean | stop (DomainParticipant participant) |
Stop capturing traffic for a DomainParticipant. More... | |
static native boolean | pause () |
Pause capturing traffic for all DomainParticipants. More... | |
static boolean | pause (DomainParticipant participant) |
Pause capturing traffic for a DomainParticipant. More... | |
static native boolean | resume () |
Resume capturing traffic for all DomainParticipants. More... | |
static boolean | resume (DomainParticipant participant) |
Resume capturing traffic for a DomainParticipant. More... | |
Network Capture APIs.
|
static |
Enable Network Capture.
This method must be called before any other Network Capture method. It must also be called before creating the participants for which we want to capture traffic.
Use this method only for debugging purposes, since it may introduce a significant performance impact.
|
static |
Disable Network Capture.
This method must be the last Network Capture method to be called. It must also be called after deleting the participants for which we captured traffic. Disabling Network Capture without stopping it first is not ok!
|
static |
Set the default Network Capture parameters.
The default parameters are used when Network Capture is started without parameters, i.e., com.rti.ndds.utility.NetworkCapture.start.
params | <<in>>. Configuration parameters that we want to set as defaults. |
References NetworkCapture.start().
|
static |
Start capturing traffic for all DomainParticipants, with the default parameters.
filename | <<in>>. The name of the output capture file will be based on this input parameter. |
In particular, the name for the capture file is the concatenation of the filename
input parameter, the "_GUID-"
string followed by the decimal representation of bytes 8-11 of the DomainParticipant's GUID, and the file extension (".pcap"
).
Referenced by NetworkCapture.set_default_params().
|
static |
Start capturing traffic for a DomainParticipant, with the default parameters.
participant | <<in>>. DomainParticipant for which we want to capture traffic. |
filename | <<in>>. The name of the output capture file will be based on this input parameter. |
In particular, the name for the capture file is the concatenation of the filename
input parameter, and the file extension (".pcap"
).
|
static |
Start capturing traffic for all DomainParticipants, with the provided parameters.
Perfoms the same function as com.rti.ndds.utility.NetworkCapture.start except that it uses the provided parameters, instead of the default ones.
filename | <<in>>. The name of the output capture file will be based on this input parameter. |
In particular, the name for the capture file is the concatenation of the filename
input parameter, the "_GUID-"
string followed by the decimal representation of bytes 8-11 of the DomainParticipant's GUID, and the file extension (".pcap"
).
params | <<in>>. Configuration parameters for the capture. |
|
static |
Start capturing traffic for a DomainParticipant, with the provided parameters.
participant | <<in>>. DomainParticipant for which we want to capture traffic. |
filename | <<in>>. The name of the output capture file will be based on this input parameter. |
In particular, the name for the capture file is the concatenation of the filename
input parameter, and the file extension (".pcap"
).
params | <<in>>. Parameters for configuring the capture. |
References NetworkCapture.stop().
|
static |
Stop capturing traffic for all participants.
This method can (and must) be called after com.rti.ndds.utility.NetworkCapture.start, not com.rti.ndds.utility.NetworkCapture.start(DomainParticipant, String). That is, if we start capturing traffic globally (for all DomainParticipants), we must stop capturing traffic also globally. It is not possible to start capturing traffic for a participant but stop it globally.
It is possible to start capturing globally and then stop capturing for a participant, as long as we eventually stop capturing traffic globally.
We must stop capturing for a participant before deleting it.
Referenced by NetworkCapture.start().
|
static |
Stop capturing traffic for a DomainParticipant.
participant | <<in>>. DomainParticipant for which we want to stop capturing traffic. |
References NetworkCapture.pause().
|
static |
Pause capturing traffic for all DomainParticipants.
Referenced by NetworkCapture.stop().
|
static |
Pause capturing traffic for a DomainParticipant.
participant | <<in>>. DomainParticipant for which we want to pause capturing traffic. |
References NetworkCapture.resume().
|
static |
Resume capturing traffic for all DomainParticipants.
Referenced by NetworkCapture.pause().
|
static |
Resume capturing traffic for a DomainParticipant.
participant | <<in>>. DomainParticipant for which we want to resume capturing traffic. |