att_security_requirement_t Struct Reference

Security requirement that can be attached to an attribute operation. More...

#include <BLETypes.h>

Inheritance diagram for att_security_requirement_t:

Public Types
enum	type { NONE , UNAUTHENTICATED , AUTHENTICATED , SC_AUTHENTICATED }
	struct scoped enum wrapped by the class More...
typedef uint8_t	representation_t
	Type of the representation. More...

Public Member Functions
	att_security_requirement_t (type value)
	Construct a new instance of att_security_requirement_t. More...
uint8_t	value () const
	Explicit access to the inner value of the SafeEnum instance. More...
const uint8_t *	storage () const
	Return a pointer to the inner storage. More...

Static Public Attributes
static const uint8_t	size = 2
	Number of bits required to store the value. More...

Detailed Description

Security requirement that can be attached to an attribute operation.

Definition at line 523 of file common/BLETypes.h.

Member Typedef Documentation

representation_t

typedef uint8_t representation_t

inherited

Type of the representation.

Definition at line 115 of file common/SafeEnum.h.

Member Enumeration Documentation

type

enum type

struct scoped enum wrapped by the class

Enumerator
NONE	The operation does not have security requirements. It is equivalent to: SecurityMode 1 level 1: No authentication, no encryption and no signing required. Note This security mode is not applicable for signed operation. Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK.
UNAUTHENTICATED	The operation requires security and there's no requirement towards peer authentication. Note Security can be achieved either by signing messages or encrypting the link. Signing is only applicable for signed write operations. Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM or SecurityManager::SECURITY_MODE_SIGNED_NO_MITM.
AUTHENTICATED	The operation requires security and the peer must be authenticated. Note Security can be achieved either by signing messages or encrypting the link. Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_WITH_MITM or SecurityManager::SECURITY_MODE_SIGNED_WITH_MITM.
SC_AUTHENTICATED	The operation require encryption with an authenticated peer that paired using secure connection pairing. Note This security mode is not applicable for signed operation; security is achieved with link encryption.

Definition at line 533 of file common/BLETypes.h.

Constructor & Destructor Documentation

att_security_requirement_t()

att_security_requirement_t

(

type

value

)

Construct a new instance of att_security_requirement_t.

Definition at line 584 of file common/BLETypes.h.

Member Function Documentation

value()

uint8_t value ( ) const

inherited

Explicit access to the inner value of the SafeEnum instance.

Definition at line 204 of file common/SafeEnum.h.

storage()

const uint8_t * storage ( ) const

inherited

Return a pointer to the inner storage.

Definition at line 211 of file common/SafeEnum.h.

Field Documentation

size

const uint8_t size = 2

static

Number of bits required to store the value.

This value can be used to define a bitfield that host a value of this enum.

Definition at line 530 of file common/BLETypes.h.