]> rtime.felk.cvut.cz Git - orte.git/blobdiff - orte/include/orte/protos_api.h
updated email address - petr@smoliku.cz
[orte.git] / orte / include / orte / protos_api.h
index 377742bcc0bdbc16039a7d2019c3056e6b24b3e2..b7664372169496e72b5ff03ddca961b1d479b334 100644 (file)
@@ -1,9 +1,18 @@
 /*
  *  $Id: protos_api.h,v 0.0.0.1             2003/09/10 
  *
- *  AUTHOR: Petr Smolik                 petr.smolik@wo.cz
- *
- *  ORTE - OCERA Real-Time Ethernet     http://www.ocera.org/
+ *  -------------------------------------------------------------------  
+ *                                ORTE                                 
+ *                      Open Real-Time Ethernet                       
+ *                                                                    
+ *                      Copyright (C) 2001-2006                       
+ *  Department of Control Engineering FEE CTU Prague, Czech Republic  
+ *                      http://dce.felk.cvut.cz                       
+ *                      http://www.ocera.org                          
+ *                                                                    
+ *  Author:             Petr Smolik    petr@smoliku.cz             
+ *  Advisor:            Pavel Pisa                                   
+ *  Project Responsible: Zdenek Hanzalek                              
  *  --------------------------------------------------------------------
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -306,6 +315,16 @@ extern int
 ORTEPublicationSendEx(ORTEPublication *cstWriter,
     ORTEPublicationSendParam *psp);
 
+/**
+ * ORTEPublicationGetInstance - return pointer to an instance
+ * @cstWriter: publication object
+ *
+ * Returns handle
+ */
+extern void *
+ORTEPublicationGetInstance(ORTEPublication *cstWriter);
+
+
 ///////////////////////////////////////////////////////////////////////////////
 // ORTESubscription.c
 
@@ -381,7 +400,7 @@ ORTESubscriptionWaitForPublications(ORTESubscription *cstReader,NtpTime wait,
 /**
  * ORTESubscriptionGetStatus - get status of a subscription
  * @cstReader: handle to subscription
- * @status: pointer to ORTESubsStatus structure 
+ * @status: pointer to ORTESubsStatus structure
  *
  * Returns ORTE_OK if successful or ORTE_BAD_HANDLE if @cstReader is not valid subscription handle.
  */
@@ -397,6 +416,16 @@ ORTESubscriptionGetStatus(ORTESubscription *cstReader,ORTESubsStatus *status);
 extern int
 ORTESubscriptionPull(ORTESubscription *cstReader);
 
+/**
+ * ORTESubscriptionGetInstance - return pointer to an instance
+ * @cstReader: publication object
+ *
+ * Returns handle
+ */
+extern void *
+ORTESubscriptionGetInstance(ORTESubscription *cstReader);
+
+
 ///////////////////////////////////////////////////////////////////////////////
 // ORTETypeRegister.c
 /**
@@ -408,10 +437,10 @@ ORTESubscriptionPull(ORTESubscription *cstReader);
  * @gms: pointer to a function given maximum length of data (in bytes)
  * @ms: default maximal size
  *
- * Each data type has to be registered. Main purpose of this process is to define serialization and deserialization functions for given data type. The same data type can be 
+ * Each data type has to be registered. Main purpose of this process is to define serialization and deserialization functions for given data type. The same data type can be
  * registered several times, previous registrations of the same type will be overwritten.
- * 
- * Examples of serialization and deserialization functions can be found if contrib/shape/ortedemo_types.c file. 
+ *
+ * Examples of serialization and deserialization functions can be found if contrib/shape/ortedemo_types.c file.
  *
  * Returns ORTE_OK if new data type has been succesfully registered.
  */