include/ssm.h

Go to the documentation of this file.

#ifndef __SSM_H__
#define __SSM_H__



//#include <stdint.h>
#ifndef __GNUC__
#  define  __attribute__(x)  /*NOTHING*/
#endif

#include "ssm-time.h"

#ifdef __cplusplus
extern "C"
{
#endif


#define SSM_SNAME_MAX 32                        
#define createSSM_time(n,u,s,l,c) createSSM(n,u,s,l,c)

    typedef
    enum
    {
        SSM_READ = 0x20,                            
        SSM_WRITE = 0x40,                           
        SSM_EXCLUSIVE = 0x80,                       
        SSM_MODE_MASK = 0xe0                        
    } SSM_open_mode;

    enum
    {
        SSM_ERROR_FUTURE = -1,                      
        SSM_ERROR_PAST = -2,                        
        SSM_ERROR_NO_DATA = -3                      
    };

    typedef char *SSM_sid;                      
    typedef int SSM_tid;                        
    /* ---- function prototypes ---- */

    void errSSM( void );

    /* system */
    int initSSM( void );

    int endSSM( void );
    
    /* open */
    SSM_sid createSSM( const char *stream_name, int stream_id, size_t stream_size, ssmTimeT life, ssmTimeT cycle ) __attribute__ ((warn_unused_result));
    
    int releaseSSM( SSM_sid *sid );
    
    SSM_sid openSSM( const char *stream_name, int stream_id, char open_mode ) __attribute__ ((warn_unused_result));

    int closeSSM( SSM_sid *sid );

    /* tid */
    SSM_tid getTID( SSM_sid sid, ssmTimeT ytime );
    
    SSM_tid getTID_top( SSM_sid sid );
    
    SSM_tid getTID_bottom( SSM_sid sid );
    
    int waitTID( SSM_sid sid, SSM_tid tid );

    /* read */
    SSM_tid readSSM( SSM_sid sid, void *data, ssmTimeT * ytime, SSM_tid tid ) __attribute__ ((warn_unused_result));

    SSM_tid readSSM_time( SSM_sid sid, void *data, ssmTimeT ytime, ssmTimeT * ret_time ) __attribute__ ((warn_unused_result));
    
    /* read with callback function */
    SSM_tid readSSMP( SSM_sid sid, void *adata, ssmTimeT * ytime, SSM_tid tid,
        void (*callback)( const void *ssmp, void *data, void *user_data ), void *user_data ) __attribute__ ((warn_unused_result));
    SSM_tid readSSMP_time( SSM_sid sid, void *adata, ssmTimeT ytime, ssmTimeT *ret_time ,
        void (*callback)( const void *ssmp, void *data, void *user_data ), void *user_data ) __attribute__ ((warn_unused_result));

    /* write */
    SSM_tid writeSSM_time( SSM_sid sid, const void *data, ssmTimeT ytime );

    SSM_tid writeSSM( SSM_sid sid, const void *data, ssmTimeT ytime );
    
    /* write with callback function */
    SSM_tid writeSSMP( SSM_sid sid, const void *adata, ssmTimeT ytime ,
         void (*callback)( void *ssmp, const void *data, void *user_data ), void *user_data );
    SSM_tid writeSSMP_time( SSM_sid sid, const void *adata, ssmTimeT ytime ,
        void (*callback)( void *ssmp, const void *data, void *user_data ), void *user_data );

    /* property */
    int set_propertySSM( const char *stream_name, int stream_id, const void *data, size_t size );

    int get_propertySSM( const char *stream_name, int stream_id, void *data );

    /* others */
    int getSSM_num( void );
    int getSSM_name( int n, char *stream_name, int *stream_id, size_t *size );
    int getSSM_info( const char *stream_name, int stream_id, size_t *size, int *num, double *cycle, size_t *property_size );
    
    int damp( SSM_sid sid, int mode, int num );

#ifdef __cplusplus
}
#endif

#endif