sassimplespace_8h_source.html

 /*

  * Copyright (c) 2005-2014 IBM Corporation.

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *     IBM Corporation, Steven Munroe - initial API and implementation

  */


 #ifndef __SAS_SIMPLE_SPACE_H

 #define __SAS_SIMPLE_SPACE_H


 #include "sastype.h"


 typedef void *SASSimpleSpace_t;


 #ifdef __cplusplus

 #define __C__ "C"

 #else

 #define __C__

 #endif


 extern __C__ SASSimpleSpace_t

 SASSimpleSpaceInit (void *heap_block, block_size_t block_size, block_size_t space_size);


 extern __C__ SASSimpleSpace_t

 SASSimpleSpaceCreate (block_size_t space_size);


 extern __C__ void*

 SASSimpleSpaceToAddr (SASSimpleSpace_t space);


 extern __C__ SASSimpleSpace_t

 SASSimpleSpaceFromAddr (void *space);


 extern __C__ int

 SASSimpleSpaceDestroy (SASSimpleSpace_t space);


 extern __C__ block_size_t

 SASSimpleSpaceFreeSpace (SASSimpleSpace_t space);


 extern __C__ int

 SASSimpleSpaceDestroyNoLock (SASSimpleSpace_t space);


 #endif /* __SAS_SIMPLE_SPACE_H */

SASSimpleSpaceToAddr
__C__ void * SASSimpleSpaceToAddr(SASSimpleSpace_t space)
Obtain the starting byte address of the simple space within the SASSimpleSpace_t block.

SASSimpleSpaceDestroy
__C__ int SASSimpleSpaceDestroy(SASSimpleSpace_t space)
Destroy a SASSimpleSpace_t and free the shared storage block.

SASSimpleSpaceFromAddr
__C__ SASSimpleSpace_t SASSimpleSpaceFromAddr(void *space)
Obtain the SASSimpleSpace_t handle from a contained space address.

SASSimpleSpace_t
void * SASSimpleSpace_t
Handle to SAS Simple Space.
Definition: sassimplespace.h:27

SASSimpleSpaceDestroyNoLock
__C__ int SASSimpleSpaceDestroyNoLock(SASSimpleSpace_t space)
Destroy a SASSimpleSpace_t and free the shared storage block.

SASSimpleSpaceInit
__C__ SASSimpleSpace_t SASSimpleSpaceInit(void *heap_block, block_size_t block_size, block_size_t space_size)
Initialize a shared storage block as a simple space.

__C__
#define __C__
ignore this macro behind the curtain
Definition: sassimplespace.h:33

SASSimpleSpaceCreate
__C__ SASSimpleSpace_t SASSimpleSpaceCreate(block_size_t space_size)
Allocate a SAS block large enough to contain the requested SAS Simple Space.

SASSimpleSpaceFreeSpace
__C__ block_size_t SASSimpleSpaceFreeSpace(SASSimpleSpace_t space)
Return the block free space not occupied by control blocks and the simple space.