Network Capture APIs.
More...
◆ enable()
| static native boolean enable |
( |
| ) |
|
|
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.
- Returns
- com.rti.dds.infrastructure.true if success. Otherwise, com.rti.dds.infrastructure.false
- MT Safety:
- UNSAFE. It is not safe to call this method while another thread may be simultaneously calling another Network Caputre related method, including this one.
- See also
- com.rti.ndds.utility.NetworkCapture.disable
◆ disable()
| static native boolean disable |
( |
| ) |
|
|
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!
- Returns
- com.rti.dds.infrastructure.true if success. Otherwise, com.rti.dds.infrastructure.false
- MT Safety:
- UNSAFE. It is not safe to call this method while another thread may be simultaneously calling another Network Capture related method, including this one.
- See also
- com.rti.ndds.utility.NetworkCapture.enable
◆ set_default_params()
◆ start() [1/4]
| static native boolean start |
( |
String |
filename | ) |
|
|
static |
◆ start() [2/4]
Start capturing traffic for a DomainParticipant, with the default parameters.
- Precondition
- This method requires first enabling Network Capture. See com.rti.ndds.utility.NetworkCapture.enable.
- 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").
- Returns
- com.rti.dds.infrastructure.true if success. Otherwise, com.rti.dds.infrastructure.false
- See also
- com.rti.ndds.utility.NetworkCapture.stop(DomainParticipant)
-
com.rti.ndds.utility.NetworkCapture.start(DDS:DomainParticipant^, System::String^, NetworkCaptureParams)
-
com.rti.ndds.utility.NetworkCapture.enable
◆ start() [3/4]
Start capturing traffic for all DomainParticipants, with the provided parameters.
- Precondition
- This method requires first enabling Network Capture. See com.rti.ndds.utility.NetworkCapture.enable.
Perfoms the same function as com.rti.ndds.utility.NetworkCapture.start except that it uses the provided parameters, instead of the default ones.
- 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").
- Parameters
-
| params | <<in>>. Configuration parameters for the capture. |
- Returns
- com.rti.dds.infrastructure.true if success. Otherwise, com.rti.dds.infrastructure.false
- See also
- com.rti.ndds.utility.NetworkCapture.stop
-
com.rti.ndds.utility.NetworkCapture.start(DDS:DomainParticipant^, System::String^, NetworkCaptureParams)
◆ start() [4/4]
◆ stop() [1/2]
| static native boolean stop |
( |
| ) |
|
|
static |
◆ stop() [2/2]
◆ pause() [1/2]
| static native boolean pause |
( |
| ) |
|
|
static |
◆ pause() [2/2]
◆ resume() [1/2]
| static native boolean resume |
( |
| ) |
|
|
static |
◆ resume() [2/2]