CHENGQI YANG / SmartLab_MuRata
Embed: (wiki syntax)

« Back to documentation index

SocketReceiveInidcation Class Reference

SocketReceiveInidcation Class Reference

This event is generated when a TCP server or a UDP server (in connected mode) receives a packet. More...

#include <SocketReceiveInidcation.h>

Inherits SmartLabMuRata::Payload.

Public Member Functions

int GetPayloadOffset ()
 Get the start index of the payload.
ResponseFlag GetResponseFlag ()
 The first byte of the Payload of the command describes the specific operation to perform for the Command ID, and it contains the Response Flag and Sub-Command ID (RFSCID).
void SetSubCommandID (const SubCommandID id)
 must call SetSubCommandID first then SetFrameID, and any other data afterwards
void SetSubCommandID (const int value)
 must call SetSubCommandID first then SetFrameID, and any other data afterwards
void SetFrameID (const char frameID)
 must call SetSubCommandID first then SetFrameID, and any other data afterwards

Detailed Description

This event is generated when a TCP server or a UDP server (in connected mode) receives a packet.

Since there is no client address and port information, the application may need to call

Definition at line 11 of file SocketReceiveInidcation.h.


Member Function Documentation

int GetPayloadOffset (  )

Get the start index of the payload.

Returns:

Definition at line 34 of file SocketReceiveInidcation.cpp.

ResponseFlag GetResponseFlag (  ) [inherited]

The first byte of the Payload of the command describes the specific operation to perform for the Command ID, and it contains the Response Flag and Sub-Command ID (RFSCID).

The Payload may be a request (REQ) from the host to the module, a response (RSP) from the module to that request, an indication (IND) from the module to the host, and the optional confirmation (CFM) from the host for that indication.

Returns:

Definition at line 34 of file Payload.cpp.

void SetFrameID ( const char  frameID ) [inherited]

must call SetSubCommandID first then SetFrameID, and any other data afterwards

Definition at line 69 of file Payload.cpp.

void SetSubCommandID ( const SubCommandID  id ) [inherited]

must call SetSubCommandID first then SetFrameID, and any other data afterwards

Definition at line 53 of file Payload.cpp.

void SetSubCommandID ( const int  value ) [inherited]

must call SetSubCommandID first then SetFrameID, and any other data afterwards

Definition at line 58 of file Payload.cpp.