mlpiApiLib.h

Go to the documentation of this file.

#ifndef __MLPIAPILIB_H__
#define __MLPIAPILIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiApiLib.h>
// -----------------------------------------------------------------------
// Copyright (c) 2013 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------









// -----------------------------------------------------------------------
// GLOBAL INCLUDES
// -----------------------------------------------------------------------
#include "mlpiGlobal.h"


// -----------------------------------------------------------------------
// GLOBAL CONSTANTS
// -----------------------------------------------------------------------
#define MLPI_CONNECT_IDENT_LENGTH               (1024)          
#define MLPI_DEFAULTPORT                        (5300)          
#define MLPI_DEFAULTSECUREPORT                  (5335)          
#define MLPI_INFINITE                           (0xFFFFFFFF)    
#define MLPI_TIMEOUT_OS                         (0)             
#define MLPI_MAX_PAYLOAD                        (500000)        

#define MLPI_API_CONNECTION_NAME_LEN            (128)           
#define MLPI_API_CONNECTION_URI_LEN             (128)           
#define MLPI_API_CONNECTION_LABEL_LEN           (254)           
#define MLPI_API_CONNECTION_USER_LEN            (128)           
#define MLPI_API_CONNECTION_PWD_LEN             (128)           

#define MLPI_API_LIBRARY_NAME_LEN               (64)            

#define MLPI_API_MAX_NUMBER_OF_CONNECTIONS      (50)            

static const WCHAR16 MLPI_LOCALHOST[]  = {'L','O','C','A','L','H','O','S','T', '\0'};                                                     
static const WCHAR16 MLPI_ACCOUNT_EMPTY_NAME[]  = {'_','A','C','C','O','U','N','T','_','E','M','P','T','Y','_','N','A','M','E','_','\0'}; 


// -----------------------------------------------------------------------
// GLOBAL ENUMERATIONS
// -----------------------------------------------------------------------
typedef enum MlpiApiProtection
{
  MLPI_API_PROTECTION_NON      = 0,   
  MLPI_API_PROTECTION_WATCHDOG = 1,   
  MLPI_API_PROTECTION_COMPLETE = 2    
}MlpiApiProtection;


// -----------------------------------------------------------------------
// GLOBAL TYPEDEFS
// -----------------------------------------------------------------------

// message packing follows 8 byte natural alignment
#if !defined(TARGET_OS_VXWORKS)
#pragma pack(push,8)
#endif

typedef struct MlpiConnectionInfo
{
  DOUBLE minimum;             
  DOUBLE maximum;             
  DOUBLE average;             
  DOUBLE variance;            
  DOUBLE standardDeviation;   
} MlpiConnectionInfo;

typedef struct MlpiConnectionDescription
{
  ULLONG              uid;                                    
  WCHAR16             user[MLPI_API_CONNECTION_USER_LEN];     
  WCHAR16             uri[MLPI_API_CONNECTION_URI_LEN];       
  WCHAR16             name[MLPI_API_CONNECTION_NAME_LEN];     
  WCHAR16             label[MLPI_API_CONNECTION_LABEL_LEN];   
  MlpiDateAndTime     dateTime;                               
  ULONG               requestCounter;                         
  ULONG               lastRequest;                            
  MlpiApiProtection   protection;                             
  ULONG               watchdog;                               
} MlpiConnectionDescription;

typedef struct MlpiLibrary
{
  WCHAR16 name[MLPI_API_LIBRARY_NAME_LEN];      
  ULONG   id;                                   
} MlpiLibrary;


#if !defined(TARGET_OS_VXWORKS)
#pragma pack(pop)
#endif



// -----------------------------------------------------------------------
// GLOBAL EXPORTS
// -----------------------------------------------------------------------
#ifdef MLPI_API
#undef MLPI_API
#endif


#if defined(TARGET_OS_WINNT)
#if defined(MLPI_EXPORTS)
#define MLPI_API __declspec(dllexport)
#elif defined(MLPI_IMPORTS)
#define MLPI_API __declspec(dllimport)
#else
#define MLPI_API
#endif
#else
#if defined(MLPI_EXPORTS)
#define MLPI_API __attribute__ ((visibility("default")))
#elif defined(MLPI_IMPORTS)
#define MLPI_API
#else
#define MLPI_API
#endif
#endif


#ifdef __cplusplus
extern "C" {
#endif


MLPI_API MLPIRESULT mlpiApiConnect(const WCHAR16* connectionIdentifier, MLPIHANDLE* connection);


MLPI_API MLPIRESULT mlpiApiDisconnect(MLPIHANDLE *connection);


MLPI_API MLPIRESULT mlpiApiSetDefaultTimeout(const ULONG timeout);


MLPI_API MLPIRESULT mlpiApiGetDefaultTimeout(ULONG *timeout);


MLPI_API MLPIRESULT mlpiApiIsConnected(const MLPIHANDLE connection, BOOL8 *isConnected);


MLPI_API MLPIRESULT mlpiApiTestConnection(const MLPIHANDLE connection, const ULONG payload, const ULONG numMeasurements, MlpiConnectionInfo *info);


MLPI_API MLPIRESULT mlpiApiNotifyAlive(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiApiDelay(const MLPIHANDLE connection, const ULONG delayMilliseconds);


MLPI_API MLPIRESULT mlpiApiGetClientCoreVersion(MlpiVersion *versionInfo);


MLPI_API MLPIRESULT mlpiApiGetServerCoreVersion(const MLPIHANDLE connection, MlpiVersion *versionInfo);


MLPI_API MLPIRESULT mlpiApiSetNameOfConnection(const MLPIHANDLE connection, const WCHAR16 *name);


MLPI_API MLPIRESULT mlpiApiSetLabelOfConnection(const MLPIHANDLE connection, const WCHAR16 *label);


MLPI_API MLPIRESULT mlpiApiGetOwnConnectionDescription(const MLPIHANDLE connection, MlpiConnectionDescription *description);


MLPI_API MLPIRESULT mlpiApiGetAllConnectionDescription(const MLPIHANDLE connection, MlpiConnectionDescription *description, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiApiCloseConnectionByUid(const MLPIHANDLE connection, const ULLONG uid);


MLPI_API MLPIRESULT mlpiApiCloseConnectionsByUser(const MLPIHANDLE connection, const WCHAR16 *user);


MLPI_API MLPIRESULT mlpiApiCloseConnectionsByUri(const MLPIHANDLE connection, const WCHAR16 *uri);


MLPI_API MLPIRESULT mlpiApiUserAccountControlReload(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiApiUserAccountControlLoadAccounts(const MLPIHANDLE connection, const WCHAR16 *path);



MLPI_API MLPIRESULT mlpiApiUserAccountControlUnloadAccounts(const MLPIHANDLE connection, const WCHAR16 *path);


MLPI_API MLPIRESULT mlpiApiGetOwnPermissions(const MLPIHANDLE connection, WCHAR16 *permissions, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiApiGetAccounts(const MLPIHANDLE connection, WCHAR16 *accounts, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiApiGetAccountPermissions(const MLPIHANDLE connection, const WCHAR16 *account, WCHAR16 *permissions, const ULONG numElements, ULONG *numElementsRet);

MLPI_API MLPIRESULT mlpiApiGetLibrarySupport(const MLPIHANDLE connection, MlpiLibrary *library, const ULONG numElements, ULONG *numElementsRet);

#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPIAPILIB_H__