+/**************************************************************************/
+/* ---------------------------------------------------------------------- */
+/* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
+/* */
+/* Universidad de Cantabria, SPAIN */
+/* University of York, UK */
+/* Scuola Superiore Sant'Anna, ITALY */
+/* Kaiserslautern University, GERMANY */
+/* Univ. Politécnica Valencia, SPAIN */
+/* Czech Technical University in Prague, CZECH REPUBLIC */
+/* ENEA SWEDEN */
+/* Thales Communication S.A. FRANCE */
+/* Visual Tools S.A. SPAIN */
+/* Rapita Systems Ltd UK */
+/* Evidence ITALY */
+/* */
+/* See http://www.frescor.org for a link to partners' websites */
+/* */
+/* FRESCOR project (FP6/2005/IST/5-034026) is funded */
+/* in part by the European Union Sixth Framework Programme */
+/* The European Union is not liable of any use that may be */
+/* made of this code. */
+/* */
+/* */
+/* This file is part of FORB (Frescor Object Request Broker) */
+/* */
+/* FORB is free software; you can redistribute it and/or modify it */
+/* under terms of the GNU General Public License as published by the */
+/* Free Software Foundation; either version 2, or (at your option) any */
+/* later version. FORB 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 along with FORB; see file */
+/* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
+/* Cambridge, MA 02139, USA. */
+/* */
+/* As a special exception, including FORB header files in a file, */
+/* instantiating FORB generics or templates, or linking other files */
+/* with FORB objects to produce an executable application, does not */
+/* by itself cause the resulting executable application 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 REQUEST_H
#define REQUEST_H
-#include <forb/forb.h>
+/**
+ * @file request.h
+ * @author Michal Sojka <sojkam1@fel.cvut.cz>
+ * @date Sun Oct 12 15:50:30 2008
+ *
+ * @brief Data type and functions for manipulation with requests.
+ *
+ *
+ */
+
+
+#include <forb.h>
#include <forb/cdr.h>
#include <forb/basic_types.h>
#include <forb/syncobj.h>
#include <ul_gavlcust.h>
#include <forb/forb-internal.h>
+
/**
* Helper structure for sending ORB requests.
*
- * It is allocated in stub's stack.
+ * Its purpose is to match incomming reply messages to previously sent
+ * requests. It is allocated in stub's stack and during waiting for
+ * reply is stored in forb_t::requests tree.
*
*/
struct forb_request {
- CORBA_unsigned_long request_id;
- CDR_Codec cdr_request;
- CDR_Codec *cdr_reply;
- gavl_node_t node;
- forb_object obj;
+ CORBA_unsigned_long request_id; /**< Numeric ID of this request. Used to match replies agains this request. */
+ FORB_CDR_Codec cdr_request; /**< Buffer for the request serialization. */
+ FORB_CDR_Codec *cdr_reply; /**< Buffer with received reply. */
+ gavl_node_t node; /**< forb_t::requests node */
+ forb_object obj; /**< Object being requested. */
struct forb_env *env; /**< Where to store exception returned in reply */
forb_syncobj_t reply_ready; /**< Synchronization object for waiting for reply */
forb_syncobj_t *reply_processed; /**< Synchronization object for receiver thread to wait for stub. */
forb_request_wait_for_reply(forb_request_t *req);
void
forb_request_signal_processed(forb_request_t *req);
-void
-forb_request_send(forb_request_t *req, CORBA_Environment *env);
-
#endif
projects / frescor / forb.git / blobdiff