Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.

Class xsi_key

boost::interprocess::xsi_key

Synopsis

// In header: <boost/interprocess/xsi_key.hpp>


class xsi_key {
public:
  // construct/copy/destruct
  xsi_key();
  xsi_key(const char *, boost::uint8_t);

  // public member functions
  key_t get_key() const;
  key_t m_key;  // @ private: 
};

Description

A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok or sets key to IPC_PRIVATE using the default constructor.

`xsi_key` public construct/copy/destruct

```
xsi_key();
```
Default constructor. Represents a private xsi_key.
```
xsi_key(const char * path, boost::uint8_t id);
```
Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error.

`xsi_key` public member functions

```
key_t get_key() const;
```
Returns the internal key_t value.