CHENGQI YANG / SmartLab_MuRata
Embed: (wiki syntax)

« Back to documentation index

HTTPResponseIndication Class Reference

HTTPResponseIndication Class Reference

The most significant bit of Content length is reserved to indicate if there is more data to send to the host. More...

#include <HTTPResponseIndication.h>

Inherits SmartLabMuRata::Payload.

Public Member Functions

bool isMoreDataComing ()
 The most significant bit of Content length is reserved to indicate if there is more data to send to the host.
int GetContentOffset ()
 Get the start index of the content.
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

The most significant bit of Content length is reserved to indicate if there is more data to send to the host.

When this bit is 1, the host application should continue to receive SNIC_HTTP_RSP_IND, until this bit is 0. The Content length is limited by the receive buffer size specified in SNIC_INIT_REQ and the system resource at that moment.

Definition at line 11 of file HTTPResponseIndication.h.


Member Function Documentation

int GetContentOffset (  )

Get the start index of the content.

Returns:

Definition at line 35 of file HTTPResponseIndication.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.

bool isMoreDataComing (  )

The most significant bit of Content length is reserved to indicate if there is more data to send to the host.

When this bit is 1, the host application should continue to receive SNIC_HTTP_RSP_IND, until this bit is 0. The Content length is limited by the receive buffer size specified in SNIC_INIT_REQ and the system resource at that moment.

Returns:

Definition at line 15 of file HTTPResponseIndication.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.