ResponseETag Property

The response ETag.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetResponseETag(char* &lpResponseETag, int &lenResponseETag);
int SetResponseETag(const char* lpResponseETag, int lenResponseETag);

Unicode (Windows)
INT GetResponseETag(LPSTR &lpResponseETag, INT &lenResponseETag);
INT SetResponseETag(LPCSTR lpResponseETag, INT lenResponseETag);

@property (nonatomic,readwrite,assign,getter=responseETag,setter=setResponseETag:) NSString* responseETag;
- (NSString*)responseETag;
- (void)setResponseETag:(NSString*)newResponseETag;

@property (nonatomic,readwrite,assign,getter=responseETagB,setter=setResponseETagB:) NSData* responseETagB;
- (NSData*)responseETagB;
- (void)setResponseETagB:(NSData*)newResponseETag;

#define PID_COAP_RESPONSEETAG 24

IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_CoAP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_CoAP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the ETag included in incoming responses (if any) anytime the RequestComplete event fires. It will be empty if an Etag option was not included.

When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the ETag that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification). Leave it empty to prevent an Etag option from being included.

This property is not available at design time.

Data Type

Binary String