L4Re - L4 Runtime Environment
L4::Ipc::Cap< T > Class Template Reference

Capability type for RPC interfaces (see L4::Cap<T>). More...

+ Collaboration diagram for L4::Ipc::Cap< T >:

Public Types

enum  { Rights_mask = 0xff, Cap_mask = L4_CAP_MASK }
 

Public Member Functions

template<typename O >
 Cap (Cap< O > const &o)
 Make copy with conversion.
 
 Cap (L4::Cap< T > cap)
 Make a Cap from L4::Cap<T>, with minimal rights.
 
template<typename O >
 Cap (L4::Cap< O > cap)
 Make IPC Cap from L4::Cap with conversion (and minimal rights).
 
 Cap ()
 Make an invalid cap.
 
 Cap (L4::Cap< T > cap, unsigned char rights)
 Make a Cap from L4::Cap<T> with the given rights. More...
 
L4::Cap< T > cap () const
 Return the L4::Cap<T> of this Cap.
 
unsigned rights () const
 Return the rights bits stored in this IPC cap.
 
L4::Ipc::Snd_fpage fpage () const
 Return the send flexpage for this Cap (see l4_fpage_t)
 
bool is_valid () const throw ()
 Return true if this Cap is valid.
 

Static Public Member Functions

static Cap from_ci (l4_cap_idx_t c)
 Create an IPC capability from a C capability index plus rights. More...
 

Detailed Description

template<typename T>
class L4::Ipc::Cap< T >

Capability type for RPC interfaces (see L4::Cap<T>).

Template Parameters
Ttype of the interface referenced by the capability.

In contrast to L4::Cap<T> this type additionally stores a rights mask that shall be used when the capability is transferred to the receiver. This allows to apply restrictions to the transferred capability in the form of a subset of the rights possessed by the sender.

See also
L4::Ipc::make_cap()

Definition at line 541 of file ipc_types.

Member Enumeration Documentation

◆ anonymous enum

template<typename T>
anonymous enum
Enumerator
Rights_mask 

Mask for rights bits stored internally.

L4_FPAGE_RIGHTS_MASK | L4_FPAGE_C_NO_REF_CNT | L4_FPAGE_C_OBJ_RIGHTS).

Cap_mask 

Mask for significant capability bits.

(incl. the invalid bit to support invalid caps)

Definition at line 547 of file ipc_types.

Constructor & Destructor Documentation

◆ Cap()

template<typename T>
L4::Ipc::Cap< T >::Cap ( L4::Cap< T >  cap,
unsigned char  rights 
)
inline

Make a Cap from L4::Cap<T> with the given rights.

Parameters
capCapability to be sent.
rightsRights to be sent. Consists of L4_fpage_rights and L4_obj_fpage_ctl.

Definition at line 589 of file ipc_types.

Member Function Documentation

◆ from_ci()

template<typename T>
static Cap L4::Ipc::Cap< T >::from_ci ( l4_cap_idx_t  c)
inlinestatic

Create an IPC capability from a C capability index plus rights.

Parameters
cC capability index with the lowest 8 bits used as rights for the map operation (see L4_fpage_rights).

Definition at line 597 of file ipc_types.


The documentation for this class was generated from the following file: