pshmbuffer.h

Go to the documentation of this file.

/*
 * The MIT License
 *
 * Copyright (C) 2010-2017 Alexander Saprykin <saprykin.spb@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
#  error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif
 
#ifndef PLIBSYS_HEADER_PSHMBUFFER_H
#define PLIBSYS_HEADER_PSHMBUFFER_H
 
#include <ptypes.h>
#include <pmacros.h>
#include <perror.h>
 
P_BEGIN_DECLS
 
typedef struct PShmBuffer_ PShmBuffer;
 
P_LIB_API PShmBuffer *  p_shm_buffer_new                (const pchar    *name,
                                                         psize          size,
                                                         PError         **error);
 
P_LIB_API void          p_shm_buffer_free               (PShmBuffer     *buf);
 
P_LIB_API void          p_shm_buffer_take_ownership     (PShmBuffer     *buf);
 
P_LIB_API pint          p_shm_buffer_read               (PShmBuffer     *buf,
                                                         ppointer       storage,
                                                         psize          len,
                                                         PError         **error);
 
P_LIB_API pssize        p_shm_buffer_write              (PShmBuffer     *buf,
                                                         ppointer       data,
                                                         psize          len,
                                                         PError         **error);
 
P_LIB_API pssize        p_shm_buffer_get_free_space     (PShmBuffer     *buf,
                                                         PError         **error);
 
P_LIB_API pssize        p_shm_buffer_get_used_space     (PShmBuffer     *buf,
                                                         PError         **error);
 
P_LIB_API void          p_shm_buffer_clear              (PShmBuffer     *buf);
 
P_END_DECLS
 
#endif /* PLIBSYS_HEADER_PSHMBUFFER_H */