Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CustomBluetoothProcess Class Reference

CustomBluetoothProcess is the process that manipulates the custom Bluetooth process. More...

Inheritance diagram for CustomBluetoothProcess:
Process

Public Member Functions

bool start (uuid)
 Starts the custom bluetooth process on the specified service uuid. More...
 
bool connect (mac, uuid)
 
bool stop ()
 Stops the custom bluetooth process. More...
 
bool isStarted ()
 Returns true if the custom bluetooth process was started, otherwise false. More...
 
uuid getServiceUuid ()
 Returns the service uuid of this custom Bluetooth process. More...
 
mac getDstMac ()
 
uuid getDstServiceUuid ()
 
bool sendData (QString, mac, uuid, FrameInstance, Port)
 Sends data over this custom Bluetooth process to the specified destination MAC address and service uuid. More...
 
bool sendDataToConnected (QString, FrameInstance, Port)
 Sends data over this custom Bluetooth process to the connected destination MAC address and service uuid. More...
 
bool processData (QString, mac, uuid, mac, uuid, FrameInstance, Port)
 This delegate processes the incoming data and returns true if successful, otherwise false. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

CustomBluetoothProcess is the process that manipulates the custom Bluetooth process.

Member Function Documentation

◆ connect()

bool CustomBluetoothProcess::connect ( mac  ,
uuid   
)

◆ getDstMac()

mac CustomBluetoothProcess::getDstMac ( )

◆ getDstServiceUuid()

uuid CustomBluetoothProcess::getDstServiceUuid ( )

◆ getServiceUuid()

uuid CustomBluetoothProcess::getServiceUuid ( )

Returns the service uuid of this custom Bluetooth process.

Returns
uuid, the service uuid of this custom Bluetooth process.

◆ isStarted()

bool CustomBluetoothProcess::isStarted ( )

Returns true if the custom bluetooth process was started, otherwise false.

Returns
bool, true if the custom bluetooth process was started, otherwise false.

◆ processData()

bool CustomBluetoothProcess::processData ( QString  ,
mac  ,
uuid  ,
mac  ,
uuid  ,
FrameInstance  ,
Port   
)

This delegate processes the incoming data and returns true if successful, otherwise false.

  • data, the data that was processed.
  • srcMac, the source MAC address.
  • srcService, the source service uuid.
  • dstMac, the destination MAC address.
  • dstService, the destination service uuid.
  • frameInstance, the FrameInstance object.
  • inPort, the incoming Port object.
Returns
bool, true if successful, otherwise false.

◆ sendData()

bool CustomBluetoothProcess::sendData ( QString  ,
mac  ,
uuid  ,
FrameInstance  ,
Port   
)

Sends data over this custom Bluetooth process to the specified destination MAC address and service uuid.

Parameters
data,thedata to send to the destination.
dstMac,theMAC address of the destination.
dstService,theservice uuid of the destination.
frameInstance,theFrameInstance object. Use createFrameInstance() to create the FrameInstance object.
outPort,thePort object where this data will be sent out of from the source device.
Returns
bool, true if successful, otherwise false.

◆ sendDataToConnected()

bool CustomBluetoothProcess::sendDataToConnected ( QString  ,
FrameInstance  ,
Port   
)

Sends data over this custom Bluetooth process to the connected destination MAC address and service uuid.

Parameters
data,thedata to send to the destination.
frameInstance,theFrameInstance object. Use createFrameInstance() to create the FrameInstance object.
outPort,thePort object where this data will be sent out of from the source device.
Returns
bool, true if successful, otherwise false.

◆ start()

bool CustomBluetoothProcess::start ( uuid  )

Starts the custom bluetooth process on the specified service uuid.

Parameters
uuid,theservice uuid.
Returns
bool, true if successful, otherwise false.

◆ stop()

bool CustomBluetoothProcess::stop ( )

Stops the custom bluetooth process.

Returns
bool, true if successful, otherwise false.

The documentation for this class was generated from the following file: