Home

Libraries

Author

Links

---

StmSharedMemorySampleMboxTypeDoc.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the SysToMath C Libraries package (LibStmC).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 1994-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/******************************************************************************
 *                       First Release 1994-07-20
 ******************************************************************************/


typedef struct StmSharedMemorySampleMboxTypeImpl_ *StmSharedMemorySampleMboxType;


typedef const struct StmSharedMemorySampleMboxTypeImpl_ *ConstStmSharedMemorySampleMboxType;


stm_static_inline StmSharedMemorySampleMboxType stmSharedMemorySampleMboxTypeCreate
(
    const char *name,
    unsigned int flags,
    void *data
);


stm_static_inline int stmSharedMemorySampleMboxTypeDestroy
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline int stmSharedMemorySampleMboxTypeInitStatus
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline int stmSharedMemorySampleMboxTypeAdjustChild
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline const char *stmSharedMemorySampleMboxTypeName
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline SampleMboxType stmSharedMemorySampleMboxTypeItem
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline SampleMboxType stmSharedMemorySampleMboxTypeLock
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline SampleMboxType stmSharedMemorySampleMboxTypeTryLock
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline SampleMboxType stmSharedMemorySampleMboxTypeTimedLock
(
    StmSharedMemorySampleMboxType shm,
    StmInt64 absTimeMs
);


stm_static_inline int stmSharedMemorySampleMboxTypeUnlock
(
    StmSharedMemorySampleMboxType shm
);


typedef struct StmSharedMemoryRefCountedSampleMboxType_ StmSharedMemoryRefCountedSampleMboxType_;


struct StmSharedMemoryRefCountedSampleMboxType_
{
    SampleMboxTypeImpl_ item;  
    int initStatus;         
    int refCount;           
};


typedef struct StmSharedMemorySampleMboxTypeImpl_ StmSharedMemorySampleMboxTypeImpl_;


#ifdef _WIN32

struct StmSharedMemorySampleMboxTypeImpl_
{
    StmSharedMemoryRefCountedSampleMboxType_ *data;

    StmSemaphore sem;      
    StmBool locked;        
    HANDLE fileMapping;    
};

#else

struct StmSharedMemorySampleMboxTypeImpl_
{
    StmSharedMemoryRefCountedSampleMboxType_ *data;

    StmL32NamedSem sem;    
    StmBool locked;        
};

#endif


stm_static_inline int stmSharedMemorySampleMboxTypeInit_
(
    StmSharedMemorySampleMboxTypeImpl_ *shm,
    const char *name,
    unsigned int flags,
    void *data
);


stm_static_inline int stmSharedMemorySampleMboxTypeDeinit_
(
    StmSharedMemorySampleMboxType shm
);


stm_static_inline StmInt64 stmSharedMemorySampleMboxTypeTimeoutMs_ (void);


stm_static_inline int stmSharedMemorySampleMboxTypeAdjustRefCount_
(
    StmSharedMemorySampleMboxType shm,
    int value,
    StmBool keepLocked
);

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).