wmp_interface.h

Go to the documentation of this file.

/*------------------------------------------------------------------------
 *---------------------           RT-WMP              --------------------
 *------------------------------------------------------------------------
 *                                                         V7.0B  11/05/10
 *
 *
 *  File: ./src/core/interface/wmp_interface.h
 *  Authors: Danilo Tardioli
 *  ----------------------------------------------------------------------
 *  Copyright (C) 2000-2010, Universidad de Zaragoza, SPAIN
 *
 *  Contact Addresses: Danilo Tardioli                   dantard@unizar.es
 *
 *  RT-WMP is free software; you can  redistribute it and/or  modify it
 *  under the terms of the GNU General Public License  as published by the
 *  Free Software Foundation;  either  version 2, or (at  your option) any
 *  later version.
 *
 *  RT-WMP  is distributed  in the  hope  that  it will be   useful, but
 *  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
 *  MERCHANTABILITY  or  FITNESS FOR A  PARTICULAR PURPOSE.    See the GNU
 *  General Public License for more details.
 *
 *  You should have received  a  copy of  the  GNU General Public  License
 *  distributed with RT-WMP;  see file COPYING.   If not,  write to the
 *  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
 *  02111-1307, USA.
 *
 *  As a  special exception, if you  link this  unit  with other  files to
 *  produce an   executable,   this unit  does  not  by  itself cause  the
 *  resulting executable to be covered by the  GNU General Public License.
 *  This exception does  not however invalidate  any other reasons why the
 *  executable file might be covered by the GNU Public License.
 *
 *----------------------------------------------------------------------*/

#ifndef WMPINTERFACE__H
#define WMPINTERFACE__H

#include <stdarg.h>
#include "wmp_config.h"
#include "Msg.h"



/* Queues*/
int          wmpPush(Msg *p);

unsigned int wmpPop(Msg * p); 

int          wmpTimedPop(Msg * p, int timeout_ms);

int          wmpNonBlockingPop(Msg * p);

#ifdef USE_MESSAGE_COMPRESSION

int wmpZPush(Msg * m);

#endif

char wmpGetNodeId(void);

char wmpGetNumOfNodes(void);

int  wmpGetLatestLQM(char * lqm);

int  wmpIsNetworkConnected(void);

int  wmpIsNetworkConnectedBlocking(int timeout_ms);

int  wmp_queue_tx_remove_head(void);

void wmpSetCpuDelay(int val);

int wmpGetCpuDelay(void);

void wmpSetTimeout(int val);

int wmpGetTimeout(void);

void wmpSetWCMult(int val);

int wmpGetWCMult(void);

void wmpSetRate(int val);

int wmpGetRate(void);

/* USER */


int wmp_queue_tx_get_room(void);

int wmpGetNumOfElementsInTXQueue(void);

int wmpGetNumOfElementsInRXQueue(int port);

int  wmpSetup(char node_id, char active_nodes);
int wmpSetupList(int _node_id, int _num_nodes, int nparam, ...);

void wmpRun(void);

void wmpRunBG(void);

void wmpExit(void);

void wmpInmediateExit(void);

void wmpSetQuiet(void);

#ifndef __KERNEL__

void wmpEnableIntControl(void);
#endif

int wmpGetNetIT(void);

unsigned int wmpGetMTU(void);


void wmpSetActiveSearch(int val);

int wmpGetActiveSearch(void);

void wmpSetInstanceId(short iid);
void wmpSetPrimBasedRouting(int val);

void wmpSetMessageReschedule(int val);

void wmpSetFlowControl(int val);

short wmpGetInstanceId(void);
int wmpGetPrimBasedRouting(void);

int wmpGetMessageReschedule(void);

int wmpGetFlowControl(void);

unsigned int wmpGetSerial(void);
unsigned int wmpGetLoopId(void);

int wmpPushData           (unsigned int port, char  * p, unsigned int   size, unsigned int   dest, signed char priority);
int wmpPopData            (unsigned int port, char ** p, unsigned int * size, unsigned char * src, signed char * priority);
int wmpPopDataTimeout     (unsigned int port, char ** p, unsigned int * size, unsigned char * src, signed char * priority, int to);
int wmpPopDataCopy        (unsigned int port, char  * p, unsigned int * size, unsigned char * src, signed char * priority);
int wmpPopDataTimeoutCopy (unsigned int port, char  * p, unsigned int * size, unsigned char * src, signed char * priority, int to);
void wmpPopDataDone       (int id);
int wmpWaitData(unsigned int port, int to);
void wmpForceTopology(char * name, int parameter);
void wmpSetRxError(char * name, int rate);
int wmpSetTaskMinimumSeparation(int port, int period);
int  wmpIsKernelSpace(void);
void wmpForceBurst(int port);
int  wmpGetLatestDistances(char * dist);

char lqm_get_val(int i, int j);
#endif