mirror of
https://github.com/mutouyun/cpp-ipc.git
synced 2025-12-07 01:06:45 +08:00
43 lines
1.2 KiB
C++
43 lines
1.2 KiB
C++
/**
|
|
* @file libipc/shm.h
|
|
* @author mutouyun (orz@orzz.org)
|
|
* @brief Define the shared memory access interface
|
|
* @date 2022-04-17
|
|
*/
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <cstddef>
|
|
|
|
#include "libimp/export.h"
|
|
#include "libimp/result.h"
|
|
|
|
#include "libipc/def.h"
|
|
|
|
LIBIPC_NAMESPACE_BEG_
|
|
|
|
struct shm_handle;
|
|
using shm_t = shm_handle *;
|
|
|
|
/// @brief Create a new shared memory handle with a name of the shared memory file.
|
|
LIBIMP_EXPORT ::LIBIMP_::result<shm_t> shm_open(std::string name,
|
|
std::size_t size = 0,
|
|
mode::type = mode::create | mode::open) noexcept;
|
|
|
|
/// @brief Close the shared memory handle.
|
|
LIBIMP_EXPORT ::LIBIMP_::result_code shm_close(shm_t) noexcept;
|
|
|
|
/// @brief Gets a memory pointer based on the shared memory handle.
|
|
/// @return nullptr on failure.
|
|
LIBIMP_EXPORT void *shm_get(shm_t) noexcept;
|
|
|
|
/// @brief Gets the memory size based on the shared memory handle.
|
|
/// @return 0 on failure.
|
|
LIBIMP_EXPORT std::size_t shm_size(shm_t) noexcept;
|
|
|
|
/// @brief Gets the name of the shared memory file based on the shared memory handle.
|
|
/// @return empty string on failure.
|
|
LIBIMP_EXPORT std::string shm_file(shm_t) noexcept;
|
|
|
|
LIBIPC_NAMESPACE_END_
|