CustomUdpProcess Class Reference

CustomUdpProcess is the process that manipulates the custom UDP process. More...

Inheritance diagram for CustomUdpProcess:

Public Member Functions
bool	start (int)
	Starts the custom UDP process on the specified port number. More...
bool	stop ()
	Stops the custom UDP process. More...
bool	isStarted ()
	Returns true if the custom UDP process was started, otherwise false. More...
int	getPortNumber ()
	Returns the port number of this custom UDP process. More...
bool	sendData (QString, QString, int, FrameInstance, Port)
	Sends data over this custom UDP process to the specified destination IP address and port number. More...
bool	sendDataWithPduInfo (QString, QString, int, FrameInstance, Port, QString, QString, QString)
	Sends data over this custom UDP process to the specified destination IP address and port number, along with PDU info. More...
bool	processData (QString, ip, int, FrameInstance, Port)
	This delegate processes the incoming data and returns true if successful, otherwise false. More...
FrameInstance	createFrameInstance (int, QString)
	Creates a frame instance. More...
void	finalizeFrameInstance (FrameInstance)
	Finalizes a frame instance. More...
Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

CustomUdpProcess is the process that manipulates the custom UDP process.

Member Function Documentation

createFrameInstance()

FrameInstance CustomUdpProcess::createFrameInstance	(	int	,
		QString
	)

Creates a frame instance.

Parameters

color,the	color for this frame instance.
dstStr,the	destination IP address for this frame instance.

Returns

FrameInstance, a FrameInstance object.

finalizeFrameInstance()

void CustomUdpProcess::finalizeFrameInstance

(

FrameInstance

)

Finalizes a frame instance.

Parameters

frameInstance,the

frame instance of interest to finalize.

getPortNumber()

int CustomUdpProcess::getPortNumber

(

)

Returns the port number of this custom UDP process.

Returns

int, the port number of this custom UDP process.

isStarted()

bool CustomUdpProcess::isStarted

(

)

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

Returns

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

processData()

bool CustomUdpProcess::processData	(	QString	,
		ip	,
		int	,
		FrameInstance	,
		Port
	)

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

• data, the data that was processed.
• srcIp, the source IP address.
• srcPort, the source port number.
• frameInstance, the FrameInstance object.
• inPort, the incoming Port object.

Returns

bool, true if successful, otherwise false.

sendData()

bool CustomUdpProcess::sendData	(	QString	,
		QString	,
		int	,
		FrameInstance	,
		Port
	)

Sends data over this custom UDP process to the specified destination IP address and port number.

Parameters

data,the	data to send to the destination.
dstIp,the	IP address of the destination.
dstPort,the	port number of the destination.
frameInstance,the	FrameInstance object. Use createFrameInstance() to create the FrameInstance object.
outPort,the	Port object where this data will be sent out of from the source device.

Returns

bool, true if successful, otherwise false.

sendDataWithPduInfo()

bool CustomUdpProcess::sendDataWithPduInfo	(	QString	,
		QString	,
		int	,
		FrameInstance	,
		Port	,
		QString	,
		QString	,
		QString
	)

Sends data over this custom UDP process to the specified destination IP address and port number, along with PDU info.

Parameters

data,the	data to send to the destination.
dstIp,the	IP address of the destination.
dstPort,the	port number of the destination.
frameInstance,the	FrameInstance object. Use createFrameInstance() to create the FrameInstance object.
outPort,the	Port object where this data will be sent out of from the source device.
customProtocol,the	custom protocol name
customPduType,the	custom PDU type
jsonFields,the	fields in JSON string representation:

Returns

bool, true if successful, otherwise false.

start()

bool CustomUdpProcess::start

(

int

)

Starts the custom UDP process on the specified port number.

Parameters

int,the

port number.

Returns

bool, true if successful, otherwise false.

stop()

bool CustomUdpProcess::stop

(

)

Stops the custom UDP process.

Returns

bool, true if successful, otherwise false.

---

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

• CCustomUdpProcess.pki