nl::Weave::Profiles::Common

This namespace includes all interfaces within Weave for the Weave Common profile.

Summary

The interfaces define message types and status codes.

Enumerations

@74 enum
Common Profile Message Types.
@75{
  kStatus_Success = 0,
  kStatus_Canceled = 1,
  kStatus_BadRequest = 0x0010,
  kStatus_UnsupportedMessage = 0x0011,
  kStatus_UnexpectedMessage = 0x0012,
  kStatus_AuthenticationRequired = 0x0013,
  kStatus_AccessDenied = 0x0014,
  kStatus_OutOfMemory = 0x0017,
  kStatus_NotAvailable = 0x0018,
  kStatus_InternalServerProblem = 0x0020,
  kStatus_Relocated = 0x0030,
  kStatus_Busy = 0x0040,
  kStatus_Timeout = 0x0041,
  kStatus_InternalError = 0x0050,
  kStatus_Continue = 0x0090
}
enum
Common Profile Status Codes.
@76{
  kMIMEType_AppOctetStream = 0x0000,
  kMIMEType_TextPlain = 0x0001,
  kMIMEType_AppGzip = 0x0002
}
enum
Common Profile MIME file type.
@77{
  kTag_SystemErrorCode = 0x0001,
  kTag_SchemaVersion = 0x0002,
  kTag_MIMEType = 0x0004
}
enum
Common Profile Data Tags.

Enumerations

@74

 @74

Common Profile Message Types.

@75

 @75

Common Profile Status Codes.

Properties
kStatus_AccessDenied

The request can only be made by a party with sufficient access.

kStatus_AuthenticationRequired

The request can only be made by an authenticated party.

kStatus_BadRequest

The request was unrecognized or malformed.

kStatus_Busy

The sender is busy and cannot perform the requested operation at the current time.

kStatus_Canceled

The operation was canceled.

kStatus_Continue

Context-specific signal to proceed.

kStatus_InternalError

An internal failure prevented an operation from completing.

kStatus_InternalServerProblem

Request could not be completeted because of problems on the server.

kStatus_NotAvailable

The requested operation cannot be performed given the current state of the sender.

kStatus_OutOfMemory

The sender is low on memory resources and cannot perform the requested operation at the current time.

kStatus_Relocated

Request was made to the wrong endpoint.

Client should query its directory server for an updated endpoint list and try again.

kStatus_Success

The operation completed without error.

kStatus_Timeout

The operation or protocol interaction failed to complete in the allotted time.

kStatus_UnexpectedMessage

A message was received at an unexpected time or in an unexpected context.

kStatus_UnsupportedMessage

An unrecognized or unsupported message was received.

@76

 @76

Common Profile MIME file type.

Properties
kMIMEType_AppGzip

gzip-compressed data.

kMIMEType_AppOctetStream

The most general unrestricted set of bytes, same as "unspecified.".

kMIMEType_TextPlain

Plain text, uncompressed.

@77

 @77

Common Profile Data Tags.

Properties
kTag_MIMEType

[uint] MIME type.

Tag Category: Profile-agnostic. Constraints: none

kTag_SchemaVersion

[uint] Schema revision.

Tag Category: Profile-specific. Constraints: 0-255

kTag_SystemErrorCode

[uint] System-specific error.

Tag Category: Profile-specific. Constraints: none