--- libaitsess/inc/aitsess.h 2013/01/17 13:10:49 1.6.4.1 +++ libaitsess/inc/aitsess.h 2013/01/17 13:26:37 1.6.4.2 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsess.h,v 1.6.4.1 2013/01/17 13:10:49 misho Exp $ +* $Id: aitsess.h,v 1.6.4.2 2013/01/17 13:26:37 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -109,7 +109,7 @@ inline void sess_SetErr(int eno, char *estr, ...); /* - * sess_initSession() Initializing session structure, + * sess_initSession() - Initializing session structure, * if session file not exists creating with specified tech * * @id = Technology using in session. SHARED_IPC IPC tech or SHARED_MAP BSD MemoryMap tech @@ -119,7 +119,7 @@ inline void sess_SetErr(int eno, char *estr, ...); */ int sess_initSession(int id, const char *csFName, ait_sess_t ** __restrict Sess); /* - * sess_freeSession() Free allocated memory for session item and delete session file if present name + * sess_freeSession() - Free allocated memory for session item and delete session file if present name * * @Sess = Session item * return: none @@ -127,7 +127,7 @@ int sess_initSession(int id, const char *csFName, ait_ void sess_freeSession(ait_sess_t ** __restrict Sess); /* - * map_createSession() MMAP Created session and allocated resources + * map_createSession() - MMAP Created session and allocated resources * * @nSeed = Seed for securing key, if =-1 must add ready for use key * @nSize = Allocated shared memory size in bytes @@ -137,7 +137,7 @@ void sess_freeSession(ait_sess_t ** __restrict Sess); */ int map_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...); /* - * map_destroySession() MMAP free shared resources + * map_destroySession() - MMAP free shared resources * * @Sess = Session item * return: none @@ -145,7 +145,7 @@ int map_createSession(int nSeed, long nSize, ait_sess_ void map_destroySession(ait_sess_t * __restrict Sess); /* - * ipc_createSession() IPC Created session and allocated resources + * ipc_createSession() - IPC Created session and allocated resources * * @nSeed = Seed for securing key, if =-1 must add ready for use key * @nSize = Allocated shared memory size in bytes @@ -155,7 +155,7 @@ void map_destroySession(ait_sess_t * __restrict Sess); */ int ipc_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...); /* - * ipc_destroySession() IPC free shared resources + * ipc_destroySession() - IPC free shared resources * * @Sess = Session item * return: none @@ -163,7 +163,7 @@ int ipc_createSession(int nSeed, long nSize, ait_sess_ void ipc_destroySession(ait_sess_t * __restrict Sess); /* - * map_attachSession() MMAP Attach to shared memory & return begin address + * map_attachSession() - MMAP Attach to shared memory & return begin address * * @s = Session item * @procMem = Custom start address (optionl) *default must be 0* @@ -171,7 +171,7 @@ void ipc_destroySession(ait_sess_t * __restrict Sess); */ void *map_attachSession(ait_sess_t * __restrict s, void *procMem); /* - * map_detachSession() MMAP Detach from shared memory + * map_detachSession() - MMAP Detach from shared memory * * @s = Session item * return: none @@ -179,7 +179,7 @@ void *map_attachSession(ait_sess_t * __restrict s, voi void map_detachSession(ait_sess_t * __restrict s); /* - * ipc_attachSession() IPC Attach to shared memory & return begin address + * ipc_attachSession() - IPC Attach to shared memory & return begin address * * @s = Session item * @procMem = Custom start address (optionl) *default must be 0* @@ -187,7 +187,7 @@ void map_detachSession(ait_sess_t * __restrict s); */ void *ipc_attachSession(ait_sess_t * __restrict s, void *procMem); /* - * ipc_detachSession() IPC Detach from shared memory + * ipc_detachSession() - IPC Detach from shared memory * * @s = Session item * return: none @@ -195,7 +195,7 @@ void *ipc_attachSession(ait_sess_t * __restrict s, voi void ipc_detachSession(ait_sess_t * __restrict s); /* - * sess_isAttached() Check for attached shared memory + * sess_isAttached() - Check for attached shared memory * * @s = Session item * return: -1 null session item, 0 not attached, 1 attached memory @@ -204,28 +204,28 @@ inline int sess_isAttached(ait_sess_t * __restrict s); /* - * map_notSemaphore() MMAP negative block if semaphore isn`t signaled + * map_notSemaphore() - MMAP negative block if semaphore isn`t signaled * * @s = Session item * return: none */ void map_notSemaphore(ait_sess_t * __restrict s); /* - * map_isSemaphoreOK() MMAP Check semaphore + * map_isSemaphoreOK() - MMAP Check semaphore * * @s = Session item * return: -1 error: can`t return semaphore, 0 = false, 1 = true */ int map_isSemaphoreOK(ait_sess_t * __restrict s); /* - * map_incSemaphore() MMAP unblock semaphore, increment semaphore + * map_incSemaphore() - MMAP unblock semaphore, increment semaphore * * @s = Session item * return: 0 Ok, -1 error: can`t increment */ int map_incSemaphore(ait_sess_t * __restrict s); /* - * map_decSemaphore() MMAP block semaphore, decrement semaphore + * map_decSemaphore() - MMAP block semaphore, decrement semaphore * * @s = Session item * return: 0 Ok, -1 error: can`t decrement @@ -233,28 +233,28 @@ int map_incSemaphore(ait_sess_t * __restrict s); int map_decSemaphore(ait_sess_t * __restrict s); /* - * ipc_notSemaphore() IPC negative block if semaphore isn`t signaled + * ipc_notSemaphore() - IPC negative block if semaphore isn`t signaled * * @s = Session item * return: none */ void ipc_notSemaphore(ait_sess_t * __restrict s); /* - * ipc_isSemaphoreOK() IPC Check semaphore + * ipc_isSemaphoreOK() - IPC Check semaphore * * @s = Session item * return: -1 error: can`t return semaphore, 0 = false, 1 = true */ int ipc_isSemaphoreOK(ait_sess_t * __restrict s); /* - * ipc_incSemaphore() IPC unblock semaphore, increment semaphore + * ipc_incSemaphore() - IPC unblock semaphore, increment semaphore * * @s = Session item * return: 0 Ok, -1 error: can`t increment */ int ipc_incSemaphore(ait_sess_t * __restrict s); /* - * ipc_decSemaphore() IPC block semaphore, decrement semaphore + * ipc_decSemaphore() - IPC block semaphore, decrement semaphore * * @s = Session item * return: 0 Ok, -1 error: can`t decrement @@ -278,33 +278,35 @@ int ipc_decSemaphore(ait_sess_t * __restrict s); /* --------------------------------------------------------- */ /* - * sess_FreeValues() Free all values from value array allocated from sess_GetValues() + * sess_FreeValues() - Free all values from value array allocated from sess_GetValues() * * @ppsVals = Array strings * return: none */ inline void sess_FreeValues(char *** __restrict ppsVals); /* - * sess_GetValues() Get all values from session shared memory + * sess_GetValues() - Get all values from session shared memory * * @s = Session item * @ppsVals = Return array strings - * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals (must be free after use!) + * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals + * (must be sess_FreeValues after use!) */ int sess_GetValues(ait_sess_t * __restrict s, char ***ppsVals); /* - * sess_GetValue() Get value from session shared memory from attribute + * sess_GetValue() - Get value from session shared memory from attribute * * @s = Session item * @csAttr = Attribute for search * @psVal = Return string buffer * @pnLen = Length of return string buffer, // *{pnLen} input is max_size of buffer & output is really taken bytes - * return: 0 not found, -1 error: in parameter, >0 get position, if define item merged with IS_DEF + * return: 0 not found, -1 error: in parameter, >0 get position, + * if define item merged with IS_DEF */ int sess_GetValue(ait_sess_t * __restrict s, const char *csAttr, char *psVal, int *pnLen); /* - * sess_DelValue() Delete item from session shared memory + * sess_DelValue() - Delete item from session shared memory * * @s = Session item * @csAttr = Attribute for erasing @@ -312,7 +314,7 @@ int sess_GetValue(ait_sess_t * __restrict s, const cha */ int sess_DelValue(ait_sess_t * __restrict s, const char *csAttr); /* - * sess_SetValue() Set item into session shared memory or update if find it + * sess_SetValue() - Set item into session shared memory or update if exists * * @s = Session item * @csAttr = Attribute @@ -323,7 +325,7 @@ int sess_DelValue(ait_sess_t * __restrict s, const cha int sess_SetValue(ait_sess_t * __restrict s, const char *csAttr, const char *psVal); /* - * sess_prepareSession() Attach to shared memory and de-marshaling data + * sess_prepareSession() - Attach to shared memory and de-marshaling data * * @s = Session * @useDirect = Use direct shared memory if !=0 or snapshot of data to array @@ -332,7 +334,7 @@ int sess_SetValue(ait_sess_t * __restrict s, const cha */ array_t *sess_prepareSession(ait_sess_t * __restrict s, char useDirect); /* - * sess_doneSession() Free resources allocated with sess_prepareSession() + * sess_doneSession() - Free resources allocated with sess_prepareSession() * * @s = Session * @arr = Array with variables for free @@ -340,7 +342,7 @@ array_t *sess_prepareSession(ait_sess_t * __restrict s */ void sess_doneSession(ait_sess_t * __restrict s, array_t ** __restrict arr); /* - * sess_commitSession() Commit data to shared memory + * sess_commitSession() - Commit data to shared memory * * @s = Session * @arr = Array with variables for save