Re: Bonobo Activation documentation update
- From: Johan Dahlin <jdahlin telia com>
- To: Maciej Stachowiak <mjs noisehavoc org>
- Cc: gnome-components-list gnome org
- Subject: Re: Bonobo Activation documentation update
- Date: 01 Dec 2001 01:29:06 +0100
lör 2001-12-01 klockan 01.14 skrev Maciej Stachowiak:
> On 30Nov2001 04:30AM (+0100), Johan Dahlin wrote:
> > Hi, i just updated the documentation for bonobo-activation.
> >
> > Ok to commit?
> >
>
> Your attachment appears as 0k in size in my mail client. Can you just
> send the patch inline in your mail message.
>
> - Maciej
>
Ok, i screw up.
Let's try again.
---
Johan Dahlin
Index: configure.in
===================================================================
RCS file: /cvs/gnome/bonobo-activation/configure.in,v
retrieving revision 1.93
diff -u -r1.93 configure.in
--- configure.in 2001/11/06 16:04:14 1.93
+++ configure.in 2001/11/28 13:49:59
@@ -182,6 +182,7 @@
bonobo-activation.spec
idl/Makefile
docs/Makefile
+api-docs/Makefile
bonobo-activation/Makefile
bonobo-activation/bonobo-activation-version.h
server/Makefile
Index: Makefile.am
===================================================================
RCS file: /cvs/gnome/bonobo-activation/Makefile.am,v
retrieving revision 1.19
diff -u -r1.19 Makefile.am
--- Makefile.am 2001/08/07 17:41:48 1.19
+++ Makefile.am 2001/11/28 13:49:59
@@ -2,6 +2,7 @@
SUBDIRS= \
po \
+ api-docs \
docs \
idl \
bonobo-activation \
Index: api-docs/architecture.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/architecture.sgml,v
retrieving revision 1.4
diff -u -r1.4 architecture.sgml
--- api-docs/architecture.sgml 2001/05/15 19:53:13 1.4
+++ api-docs/architecture.sgml 2001/11/28 13:49:59
@@ -1,19 +1,19 @@
<chapter id="architecture">
-<title>OAF Architecture</title>
+<title>Bonobo Activation Architecture</title>
<sect1 id="oaf-daemon">
-<title>The OAF daemon</title>
+<title>The Bonobo Activation daemon</title>
<para>
-OAF is nothing but a daemon implementing a set of CORBA interfaces.
-These CORBA interfaces implement a Name service for the set of CORBA
-servers installed on your system. Basically, OAF knows about all the
-CORBA servers of your system, running or not. The OAF daemon
-will activate those servers if you ask for them.
+Bonobo Activation is nothing but a daemon implementing a set of
+CORBA interfaces. These CORBA interfaces implement a Name service
+for the set of CORBA servers installed on your system. Basically,
+OAF knows about all the CORBA servers of your system, running or not.
+The OAF daemon will activate those servers if you ask for them.
</para>
<para>
-The OAF daemon features a powerful query langage which allows you to
-ask for certain services rather than for certain applications.
+The Bonobo Activation daemon features a powerful query langage which
+allows you to ask for certain services rather than for certain applications.
</para>
<para>
@@ -37,7 +37,7 @@
</para>
<para>
-Each server is described by its .oafinfo file which contains among others
+Each server is described by its .server file which contains among others
the IDL interfaces this server implements, some specific properties and
an <emphasis>IID</emphasis> (Implementation ID). Each IID has to be unique.
Its format is pretty simple:
@@ -122,7 +122,8 @@
<para>
Of course, liboaf provides comvenient wrappers for those CORBA functions. Those are named
-<function>oaf_activate_async</function> and <function>oaf_activate_from_id_async</function>.
+<function>bonobo_activation_activate_async</function> and
+<function>bonobo_activation_activate_from_id_async</function>.
</para>
</sect1>
Index: api-docs/bonobo-activation-decl.txt
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/bonobo-activation-decl.txt,v
retrieving revision 1.7
diff -u -r1.7 bonobo-activation-decl.txt
--- api-docs/bonobo-activation-decl.txt 2000/11/16 09:14:56 1.7
+++ api-docs/bonobo-activation-decl.txt 2001/11/28 13:49:59
@@ -1,194 +1,194 @@
<STRUCT>
-<NAME>OAFActivationInfo</NAME>
+<NAME>BonoboActivationInfo</NAME>
typedef struct
{
char *iid; /* Implementation ID */
char *user; /* You owe this field to boc */
char *host; /* DNS name or IP address */
char *domain; /* This is not a DNS domain, but an activation domain */
-} OAFActivationInfo;
+} BonoboActivationInfo;
</STRUCT>
<ENUM>
-<NAME>OAF_PropertyType</NAME>
+<NAME>Bonobo_ActivationPropertyType</NAME>
typedef enum
{
- OAF_P_STRING,
- OAF_P_NUMBER,
- OAF_P_BOOLEAN,
- OAF_P_STRINGV
+ Bonobo_ACTIVATION_P_STRING,
+ Bonobo_ACTIVATION_P_NUMBER,
+ Bonobo_ACTIVATION_P_BOOLEAN,
+ Bonobo_ACTIVATION_P_STRINGV
}
- OAF_PropertyType;
+ Bonobo_ActivationPropertyType;
</ENUM>
<STRUCT>
-<NAME>OAF_Property</NAME>
+<NAME>Bonobo_ActivationProperty</NAME>
typedef struct
{
- CORBA_char *name;
- OAF_PropertyValue v;
+ CORBA_string name;
+ Bonobo_ActivationPropertyValue v;
}
- OAF_Property;
+ Bonobo_ActivationProperty;
</STRUCT>
<STRUCT>
-<NAME>OAF_PropertyValue</NAME>
+<NAME>Bonobo_ActivationPropertyValue</NAME>
typedef struct
{
- OAF_PropertyType _d;
+ Bonobo_ActivationPropertyType _d;
union
{
- CORBA_char *value_string;
+ CORBA_string value_string;
CORBA_double value_number;
CORBA_boolean value_boolean;
- GNOME_stringlist value_stringv;
+ Bonobo_StringList value_stringv;
}
_u;
}
- OAF_PropertyValue;
+ Bonobo_ActivationPropertyValue;
</STRUCT>
<STRUCT>
-<NAME>OAF_ServerInfo</NAME>
+<NAME>Bonobo_ServerInfo</NAME>
typedef struct
{
- OAF_ImplementationID iid;
- CORBA_char *server_type;
- CORBA_char *location_info;
- CORBA_char *username;
- CORBA_char *hostname;
- CORBA_char *domain;
- CORBA_sequence_OAF_Property props;
+ Bonobo_ImplementationID iid;
+ CORBA_string server_type;
+ CORBA_string location_info;
+ CORBA_string username;
+ CORBA_string hostname;
+ CORBA_string domain;
+ CORBA_sequence_Bonobo_ActivationProperty props;
}
- OAF_ServerInfo;
+ Bonobo_ServerInfo;
</STRUCT>
<ENUM>
-<NAME>OAF_RegistrationResult</NAME>
+<NAME>Bonobo_RegistrationResult</NAME>
typedef enum
{
- OAF_REG_SUCCESS,
- OAF_REG_NOT_LISTED,
- OAF_REG_ALREADY_ACTIVE,
- OAF_REG_ERROR
+ Bonobo_ACTIVATION_REG_SUCCESS,
+ Bonobo_ACTIVATION_REG_NOT_LISTED,
+ Bonobo_ACTIVATION_REG_ALREADY_ACTIVE,
+ Bonobo_ACTIVATION_REG_ERROR
}
- OAF_RegistrationResult;
+ Bonobo_RegistrationResult;
</ENUM>
<TYPEDEF>
-<NAME>OAF_ActivationFlags</NAME>
- typedef CORBA_long OAF_ActivationFlags;
-#define OAF_FLAG_NO_LOCAL 1 /* no shared libraries */
-#define OAF_FLAG_PRIVATE 2 /* start a new server and don't register it */
-#define OAF_FLAG_EXISTING_ONLY 4 /* don't start the server if not started */
+<NAME>Bonobo_ActivationFlags</NAME>
+ typedef CORBA_long Bonobo_ActivationFlags;
+#define Bonobo_ACTIVATION_FLAG_NO_LOCAL 1 /* no shared libraries */
+#define Bonobo_ACTIVATION_FLAG_PRIVATE 2 /* start a new server and don't register it */
+#define Bonobo_ACTIVATION_FLAG_EXISTING_ONLY 4 /* don't start the server if not started */
</TYPEDEF>
<TYPEDEF>
-<NAME>OAF_ActivationID</NAME>
- typedef CORBA_char *OAF_ActivationID;
+<NAME>Bonobo_ActivationID</NAME>
+ typedef CORBA_string Bonobo_ActivationID;
</TYPEDEF>
<TYPEDEF>
-<NAME>OAF_ImplementationID</NAME>
- typedef CORBA_char *OAF_ImplementationID;
+<NAME>Bonobo_ImplementationID</NAME>
+ typedef CORBA_string Bonobo_ImplementationID;
</TYPEDEF>
<FUNCTION>
-<NAME>oaf_actinfo_stringify</NAME>
-<RETURNS>char *</RETURNS>
-const OAFActivationInfo * actinfo
+<RETURNS>Bonobo_ActivationID</RETURNS>
+<NAME>bonobo_activation_info_stringify</NAME>
+const BonoboActivationInfo * actinfo
</FUNCTION>
<FUNCTION>
-<RETURNS>OAFActivationInfo *</RETURNS>
-<NAME>oaf_servinfo_to_actinfo</NAME>
-const OAF_ServerInfo * servinfo
+<RETURNS>BonoboActivationInfo *</RETURNS>
+<NAME>bonobo_activation_servinfo_to_actinfo</NAME>
+const Bonobo_ServerInfo * servinfo
</FUNCTION>
<FUNCTION>
-<RETURNS>void</RETURNS>
-<NAME>oaf_actinfo_free</NAME>
-OAFActivationInfo * actinfo
+<RETURNS>BonoboActivationInfo *</RETURNS>
+<NAME>bonobo_activation_id_parse</NAME>
+const CORBA_char *actid
</FUNCTION>
<FUNCTION>
-<RETURNS>OAFActivationInfo *</RETURNS>
-<NAME>oaf_actinfo_new</NAME>
+<RETURNS>BonoboActivationInfo *</RETURNS>
+<NAME>bonobo_activation_info_new</NAME>
void
</FUNCTION>
<FUNCTION>
-<RETURNS>OAFActivationInfo *</RETURNS>
-<NAME>oaf_actid_parse</NAME>
-const OAF_ActivationID actid
+<RETURNS>void</RETURNS>
+<NAME>bonobo_activation_info_free</NAME>
+BonoboActivationInfo * actinfo
</FUNCTION>
<FUNCTION>
<RETURNS>CORBA_Context </RETURNS>
-<NAME>oaf_context_get</NAME>
+<NAME>bonobo_activation_context_get</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>CORBA_ORB </RETURNS>
-<NAME>oaf_orb_get</NAME>
+<NAME>bonobo_activation_orb_get</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>CORBA_ORB</RETURNS>
-<NAME>oaf_init</NAME>
+<NAME>bonobo_activation_init</NAME>
int argc,
char **argv
</FUNCTION>
<FUNCTION>
<RETURNS>void</RETURNS>
-<NAME>oaf_set_test_components_enabled</NAME>
+<NAME>bonobo_activation_set_test_components_enabled</NAME>
gboolean val
</FUNCTION>
<FUNCTION>
<RETURNS>gboolean</RETURNS>
-<NAME>oaf_get_test_components_enabled</NAME>
+<NAME>bonobo_activation_get_test_components_enabled</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>gboolean</RETURNS>
-<NAME>oaf_is_initialized</NAME>
+<NAME>bonobo_activation_is_initialized</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>const char *</RETURNS>
-<NAME>oaf_hostname_get</NAME>
+<NAME>bonobo_activation_hostname_get</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>const char *</RETURNS>
-<NAME>oaf_domain_get</NAME>
+<NAME>bonobo_activation_domain_get</NAME>
void
</FUNCTION>
<FUNCTION>
<RETURNS>const char *</RETURNS>
-<NAME>oaf_session_name_get</NAME>
+<NAME>bonobo_activation_session_name_get</NAME>
void
</FUNCTION>
<MACRO>
-<NAME>oaf_username_get</NAME>
-#define oaf_username_get() g_get_user_name()
+<NAME>bonobo_activation_username_get</NAME>
+#define bonobo_activation_username_get() g_get_user_name()
</MACRO>
<STRUCT>
-<NAME>OAFPluginObject</NAME>
+<NAME>BonoboActivationPluginObject</NAME>
typedef struct
{
const char *iid;
@@ -208,44 +208,44 @@
* implementation's destruction routine. */
CORBA_Environment * ev);
}
-OAFPluginObject;
+BonoboActivationPluginObject;
</STRUCT>
<STRUCT>
-<NAME>OAFPlugin</NAME>
+<NAME>BonoboActivationPlugin</NAME>
typedef struct
{
- const OAFPluginObject *plugin_object_list;
+ const BonoboActivationPluginObject *plugin_object_list;
const char *description;
}
-OAFPlugin;
+BonoboActivationPlugin;
</STRUCT>
<FUNCTION>
<RETURNS>CORBA_Object</RETURNS>
-<NAME>oaf_server_activate_shlib</NAME>
+<NAME>bonobo_activation_activate_shlib_server</NAME>
OAF_ActivationResult * sh,
CORBA_Environment * ev
</FUNCTION>
<FUNCTION>
<RETURNS>void</RETURNS>
-<NAME>oaf_plugin_unuse</NAME>
+<NAME>bonobo_activation_plugin_unuse</NAME>
gpointer impl_ptr
</FUNCTION>
<FUNCTION>
<RETURNS>void</RETURNS>
-<NAME>oaf_plugin_use</NAME>
+<NAME>bonobo_activation_plugin_use</NAME>
PortableServer_Servant servant,
gpointer impl_ptr
</FUNCTION>
<FUNCTION>
<RETURNS>OAF_ServerInfoList *</RETURNS>
-<NAME>oaf_query</NAME>
+<NAME>bonobo_activation_query</NAME>
const char *requirements,
char *const *selection_order,
CORBA_Environment * ev
@@ -253,7 +253,7 @@
<FUNCTION>
<RETURNS>CORBA_Object</RETURNS>
-<NAME>oaf_activate_from_id</NAME>
+<NAME>bonobo_activation_activate_from_id</NAME>
const OAF_ActivationID aid,
OAF_ActivationFlags flags,
OAF_ActivationID * ret_aid,
@@ -262,7 +262,7 @@
<FUNCTION>
<RETURNS>CORBA_Object</RETURNS>
-<NAME>oaf_activate</NAME>
+<NAME>bonobo_activation_activate</NAME>
const char *requirements,
char *const *selection_order,
OAF_ActivationFlags flags,
@@ -271,16 +271,16 @@
</FUNCTION>
<TYPEDEF>
-<NAME>OAFActivationCallback</NAME>
-typedef void (*OAFActivationCallback) (CORBA_Object activated_object,
- const char *error_reason,
- gpointer user_data);
+<NAME>BonoboActivationCallback</NAME>
+typedef void (*BonoboActivationCallback) (CORBA_Object activated_object,
+ const char *error_reason,
+ gpointer user_data);
</TYPEDEF>
<FUNCTION>
<RETURNS>void</RETURNS>
-<NAME>oaf_activate_async</NAME>
+<NAME>bonobo_activation_activate_async</NAME>
const char *requirements,
char *const *selection_order,
OAF_ActivationFlags flags,
@@ -291,7 +291,7 @@
<FUNCTION>
<RETURNS>void</RETURNS>
-<NAME>oaf_activate_from_id_async</NAME>
+<NAME>bonobo_activation_activate_from_id_async</NAME>
const OAF_ActivationID aid,
OAF_ActivationFlags flags,
OAFActivationCallback callback,
@@ -301,7 +301,7 @@
<FUNCTION>
-<NAME>oaf_active_server_unregister</NAME>
+<NAME>bonobo_activation_active_server_unregister</NAME>
<RETURNS>void</RETURNS>
const char *iid,
CORBA_Object obj
@@ -309,40 +309,40 @@
<FUNCTION>
<RETURNS>OAF_RegistrationResult</RETURNS>
-<NAME>oaf_active_server_register</NAME>
+<NAME>bonobo_activation_active_server_register</NAME>
const char *iid,
CORBA_Object obj
</FUNCTION>
<FUNCTION>
<RETURNS>const char *</RETURNS>
-<NAME>oaf_server_info_prop_lookup</NAME>
-OAF_ServerInfo * server,
+<NAME>bonobo_server_info_prop_lookup</NAME>
+Bonobo_ServerInfo * server,
const char *prop_name,
GSList * i18n_languages
</FUNCTION>
<FUNCTION>
-<RETURNS>OAF_Property *</RETURNS>
-<NAME>oaf_server_info_prop_find</NAME>
-OAF_ServerInfo * server,
+<RETURNS>Bonobo_ActivationProperty *</RETURNS>
+<NAME>bonobo_server_info_prop_find</NAME>
+Bonobo_ServerInfo * server,
const char *prop_name
</FUNCTION>
<FUNCTION>
-<RETURNS>OAF_ServerInfo *</RETURNS>
-<NAME>OAF_ServerInfo_duplicate</NAME>
-const OAF_ServerInfo *original
+<RETURNS>Bonobo_ServerInfo *</RETURNS>
+<NAME>Bonobo_ServerInfo_duplicate</NAME>
+const Bonobo_ServerInfo *original
</FUNCTION>
<FUNCTION>
<RETURNS>CORBA_Object</RETURNS>
-<NAME>oaf_name_service_get</NAME>
+<NAME>bonobo_activation_name_service_get</NAME>
CORBA_Environment * ev
</FUNCTION>
<FUNCTION>
<RETURNS>const char *</RETURNS>
-<NAME>oaf_activation_iid_get</NAME>
+<NAME>bonobo_activation_activation_iid_get</NAME>
void
</FUNCTION>
Index: api-docs/bonobo-activation-sections.txt
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/bonobo-activation-sections.txt,v
retrieving revision 1.6
diff -u -r1.6 bonobo-activation-sections.txt
--- api-docs/bonobo-activation-sections.txt 2000/11/16 09:14:56 1.6
+++ api-docs/bonobo-activation-sections.txt 2001/11/28 13:49:59
@@ -1,60 +1,61 @@
-<INCLUDE>liboaf/liboaf.h</INCLUDE>
+<INCLUDE>bonobo-activation/bonobo-activation.h</INCLUDE>
<SECTION>
<FILE>utilities</FILE>
<TITLE>Utilities</TITLE>
-OAF_Property
-OAF_PropertyValue
-OAF_PropertyType
-oaf_server_info_prop_find
-OAFActivationInfo
-oaf_actinfo_stringify
-oaf_servinfo_to_actinfo
-oaf_actid_parse
-oaf_actinfo_free
-OAF_ServerInfo_duplicate
+Bonobo_ActivationProperty
+Bonobo_ActivationPropertyValue
+Bonobo_ActivationPropertyType
+bonobo_server_info_prop_find
+BonoboActivationInfo
+bonobo_activation_info_stringify
+bonobo_activation_servinfo_to_actinfo
+bonobo_activation_id_parse
+bonobo_activation_info_new
+bonobo_activation_info_free
+Bonobo_ServerInfo_duplicate
</SECTION>
<SECTION>
<FILE>query</FILE>
<TITLE>Query and Activation</TITLE>
-OAF_ImplementationID
-OAF_ActivationID
-OAF_ServerInfo
-OAF_ActivationFlags
-oaf_query
-oaf_activate
-oaf_activate_from_id
-OAFActivationCallback
-oaf_activate_async
-oaf_activate_from_id_async
+Bonobo_ImplementationID
+Bonobo_ActivationID
+Bonobo_ServerInfo
+Bonobo_ActivationFlags
+bonobo_activation_query
+bonobo_activation_activate
+bonobo_activation_activate_from_id
+BonoboActivationCallback
+bonobo_activation_activate_async
+bonobo_activation_activate_from_id_async
</SECTION>
<SECTION>
<FILE>registration</FILE>
<TITLE>Registration</TITLE>
-OAF_RegistrationResult
-oaf_active_server_register
-oaf_active_server_unregister
-
-OAFPlugin
-OAFPluginObject
-oaf_plugin_use
-oaf_plugin_unuse
+Bonobo_RegistrationResult
+bonobo_activation_active_server_register
+bonobo_activation_active_server_unregister
+
+BonoboActivationPlugin
+BonoboActivationPluginObject
+bonobo_activation_plugin_use
+bonobo_activation_plugin_unuse
</SECTION>
<SECTION>
<FILE>initialization</FILE>
<TITLE>Initialization</TITLE>
-oaf_is_initialized
-oaf_init
-oaf_orb_get
-oaf_name_service_get
+bonobo_activation_is_initialized
+bonobo_activation_init
+bonobo_activation_orb_get
+bonobo_activation_name_service_get
</SECTION>
<SECTION>
<FILE>debugging</FILE>
<TITLE>Debugging</TITLE>
-oaf_get_test_components_enabled
-oaf_set_test_components_enabled
-</SECTION>
\ No newline at end of file
+bonobo_activation_get_test_components_enabled
+bonobo_activation_set_test_components_enabled
+</SECTION>
Index: api-docs/bonobo-activation.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/bonobo-activation.sgml,v
retrieving revision 1.6
diff -u -r1.6 bonobo-activation.sgml
--- api-docs/bonobo-activation.sgml 2001/08/07 08:49:57 1.6
+++ api-docs/bonobo-activation.sgml 2001/11/28 13:49:59
@@ -16,7 +16,7 @@
<book>
<bookinfo>
- <title>The liboaf Library</title>
+ <title>Bonobo Activation API Reference Manual</title>
<authorgroup>
<author>
@@ -37,7 +37,7 @@
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being Tutorial, Configuring, Architecture,
- Query Langage, .oafinfo reference, Migrating and API reference with no
+ Query Langage, .servver reference, Migrating and API reference with no
Front-Cover Texts, and with no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
@@ -64,7 +64,7 @@
<title>API Reference</title>
<para>
This part presents the function reference for the
- liboaf library.
+ bonobo activation library.
</para>
&init;
Index: api-docs/configuring.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/configuring.sgml,v
retrieving revision 1.3
diff -u -r1.3 configuring.sgml
--- api-docs/configuring.sgml 2001/05/15 19:53:13 1.3
+++ api-docs/configuring.sgml 2001/11/28 13:49:59
@@ -1,11 +1,11 @@
<chapter id="configuring">
-<title>Configuring OAF</title>
+<title>Configuring Bonobo Activation</title>
<sect1>
-<title>.oafinfo search path.</title>
+<title>.server search path.</title>
<para>
To know the list of available CORBA servers on your local machine, the OAF daemon
-searches a number of directories for .oafinfo XML files which contain the description
+searches a number of directories for .server XML files which contain the description
of the services offered by these servers.
By default, OAF will try to find them in ${prefix}/share/oaf which may be a problem
if users install other applications using OAF in different prefixes.
Index: api-docs/server-xml-reference.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/server-xml-reference.sgml,v
retrieving revision 1.1
diff -u -r1.1 server-xml-reference.sgml
--- api-docs/server-xml-reference.sgml 2001/08/07 08:49:57 1.1
+++ api-docs/server-xml-reference.sgml 2001/11/28 13:49:59
@@ -1,9 +1,9 @@
<chapter id="server-xml-reference">
-<title><filename>.oafinfo</filename> file format reference</title>
+<title><filename>.server</filename> file format reference</title>
<para>
-This section describes the format of the .oafinfo files
-used by applications to tell the OAF daemon about the
+This section describes the format of the .server files
+used by applications to tell the Bonobo Activation daemon about the
interfaces they support.
</para>
Index: api-docs/tutorial.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/tutorial.sgml,v
retrieving revision 1.4
diff -u -r1.4 tutorial.sgml
--- api-docs/tutorial.sgml 2001/05/15 19:53:13 1.4
+++ api-docs/tutorial.sgml 2001/11/28 13:49:59
@@ -1,11 +1,11 @@
<chapter id="tutorial">
-<title>OAF tutorial</title>
+<title>Bonobo Activation tutorial</title>
<sect1>
- <title>What is OAF ?</title>
+ <title>What is Bonobo Activation ?</title>
<para>
- OAF was designed as a replacement for the limited libgnorba library used
+ Bonobo Activation was designed as a replacement for the limited libgnorba library used
in GNOME. libgnorba is responsible on GNOME 1.0.x and 1.2.x systems for
the activation of CORBA objects. libgnorba allows you to browse the available
CORBA servers on your system (running or not). It keeps track of the running
@@ -48,26 +48,26 @@
</para>
<para>
- OAF was designed to address these issues. The remote issue is completely solved
- by the oaf daemon (see <xref linkend="architecture">), the evil hacks regarding X are
+ Bonobo Activation was designed to address these issues. The remote issue is completely solved
+ by the Bonobo Activation daemon (see <xref linkend="architecture">), the evil hacks regarding X are
part of our past and the grand <emphasis>OAF query langage</emphasis> (see
<xref linkend="query-langage">) gives you the ability to perform arbitrary queries
on the database of CORBA servers.
</para>
<para>
- Basically, OAF keeps track of all the CORBA servers installed on your machine and
- can track any other machine's CORBA servers provided you set up OAF correctly and
+ Basically, Bonobo Activation keeps track of all the CORBA servers installed on your machine and
+ can track any other machine's CORBA servers provided you set up Bonobo Activation correctly and
allows you to perform queries on the properties of these servers.
The following very simple example will make things rather clear:
<programlisting>
-CORBA_Object o = oaf_activate ("repo_ids.has ('IDL:GNOME/Graph/Layout:1.0')",
- NULL, 0, NULL, &ev);
+CORBA_Object o = bonobo_activation_activate ("repo_ids.has ('IDL:GNOME/Graph/Layout:1.0')",
+ NULL, 0, NULL, &ev);
</programlisting>
This will ask for a component which supports the GNOME/Graph/Layout:1.0 interface.
- You can also do much more complicated things. OAF will find one whcih matches the
+ You can also do much more complicated things. Bonobo Activation will find one whcih matches the
query and will take all the necessary measures required to get the server running
(if it is a shared library progam, it will load the relevant library in memory.
If you need a Factory, it will launch the factory and request the factory to create
@@ -81,9 +81,9 @@
<title>Getting started</title>
<para>
- Here follows a very simple-stupid example of what you can do with OAF.
- The complete API description of liboaf, the OAF query langage reference and the
- <filename>.oafinfo</filename> file format reference are included in this
+ Here follows a very simple-stupid example of what you can do with Bonobo Activation.
+ The complete API description of bonobo activation, the OAF query langage reference and the
+ <filename>.server</filename> file format reference are included in this
document and are recommended readings. Reading <xref linkend="architecture"> is
also a good idea.
</para>
@@ -96,7 +96,7 @@
<title>Checklist</title>
<para>
- If you plan to use OAF for your own CORBA servers, you should use the following simple
+ If you plan to use Bonobo Activation for your own CORBA servers, you should use the following simple
checklist.
<itemizedlist>
@@ -111,25 +111,26 @@
<listitem>
<para>
- Create a proper <filename>.oafinfo</filename> file for your server describing its
+ Create a proper <filename>.server</filename> file for your server describing its
IDL interfaces, its main properties and the way it is to be activated.
</para>
</listitem>
<listitem>
<para>
- Call <function>oaf_init</function> (make sure you do not initialize twice by calling
- <function>oaf_is_initialized</function>). Then, call <function>oaf_active_server_register</function>
- to register yourself as running to the OAF daemon.
+ Call <function>bonobo_activation_init</function> (make sure you do not initialize twice by calling
+ <function>bonobo_activation_is_initialized</function>). Then, call
+ <function>bonobo_activation_active_server_register</function>
+ to register yourself as running to the Bonobo Activation daemon.
</para>
</listitem>
</itemizedlist>
If you are a client willing to activate a few servers, it is a little simpler: you
- just must make sure you call the <function>oaf_init</function> function and you can then
- call <function>oaf_query</function> or <function>oaf_activate</function> or
- <function>oaf_activate_from_id</function>.
+ just must make sure you call the <function>bonobo_activation_init</function> function and you can then
+ call <function>bonobo_activation_query</function> or <function>bonobo_activation_activate</function> or
+ <function>bonobo_activation_activate_from_id</function>.
</para>
<para>
Index: api-docs/tmpl/initialization.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/tmpl/initialization.sgml,v
retrieving revision 1.2
diff -u -r1.2 initialization.sgml
--- api-docs/tmpl/initialization.sgml 2000/10/25 18:22:47 1.2
+++ api-docs/tmpl/initialization.sgml 2001/11/28 13:49:59
@@ -2,12 +2,12 @@
Initialization
<!-- ##### SECTION Short_Description ##### -->
-Initializing OAF and its ORB.
+Initializing Bonobo Activation and its ORB.
<!-- ##### SECTION Long_Description ##### -->
<para>
-These functions allow you to initialize OAF and the ORB
-it is using. Initializing OAF launches the OAF daemon if
+These functions allow you to initialize Bonobo Activation and the ORB
+it is using. Initializing Bonobo Activation launches the Bonobo Activation daemon if
it is not started.
</para>
@@ -16,7 +16,7 @@
</para>
-<!-- ##### FUNCTION oaf_is_initialized ##### -->
+<!-- ##### FUNCTION bonobo_activation_is_initialized ##### -->
<para>
</para>
@@ -24,7 +24,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_init ##### -->
+<!-- ##### FUNCTION bonobo_activation_init ##### -->
<para>
</para>
@@ -34,7 +34,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_orb_get ##### -->
+<!-- ##### FUNCTION bonobo_activation_orb_get ##### -->
<para>
</para>
@@ -42,7 +42,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_name_service_get ##### -->
+<!-- ##### FUNCTION bonobo_activation_name_service_get ##### -->
<para>
</para>
Index: api-docs/tmpl/query.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/tmpl/query.sgml,v
retrieving revision 1.1
diff -u -r1.1 query.sgml
--- api-docs/tmpl/query.sgml 2000/10/25 17:16:45 1.1
+++ api-docs/tmpl/query.sgml 2001/11/28 13:49:59
@@ -22,31 +22,31 @@
</para>
-<!-- ##### TYPEDEF OAF_ImplementationID ##### -->
+<!-- ##### TYPEDEF Bonobo_ImplementationID ##### -->
<para>
</para>
-<!-- ##### TYPEDEF OAF_ActivationID ##### -->
+<!-- ##### TYPEDEF Bonobo_ActivationID ##### -->
<para>
</para>
-<!-- ##### STRUCT OAF_ServerInfo ##### -->
+<!-- ##### STRUCT Bonobo_ServerInfo ##### -->
<para>
</para>
-<!-- ##### TYPEDEF OAF_ActivationFlags ##### -->
+<!-- ##### TYPEDEF Bonobo_ActivationFlags ##### -->
<para>
</para>
-<!-- ##### FUNCTION oaf_query ##### -->
+<!-- ##### FUNCTION bonobo_activation_query ##### -->
<para>
</para>
@@ -57,7 +57,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_activate ##### -->
+<!-- ##### FUNCTION bonobo_activation_activate ##### -->
<para>
</para>
@@ -70,7 +70,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_activate_from_id ##### -->
+<!-- ##### FUNCTION bonobo_activation_activate_from_id ##### -->
<para>
</para>
@@ -82,14 +82,14 @@
@Returns:
-<!-- ##### STRUCT OAFActivationCallback ##### -->
+<!-- ##### STRUCT BonoboActivationCallback ##### -->
<para>
This is the signature of the function which you must pass
as a callback to the asynchrounous activation functions.
</para>
-<!-- ##### FUNCTION oaf_activate_async ##### -->
+<!-- ##### FUNCTION bonobo_activation_activate_async ##### -->
<para>
</para>
@@ -102,7 +102,7 @@
@ev:
-<!-- ##### FUNCTION oaf_activate_from_id_async ##### -->
+<!-- ##### FUNCTION bonobo_activation_activate_from_id_async ##### -->
<para>
</para>
Index: api-docs/tmpl/registration.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/tmpl/registration.sgml,v
retrieving revision 1.2
diff -u -r1.2 registration.sgml
--- api-docs/tmpl/registration.sgml 2000/10/25 18:22:47 1.2
+++ api-docs/tmpl/registration.sgml 2001/11/28 13:49:59
@@ -2,13 +2,13 @@
Registration
<!-- ##### SECTION Short_Description ##### -->
-Registering CORBA objects to OAF.
+Registering CORBA objects to Bonobo Activation.
<!-- ##### SECTION Long_Description ##### -->
<para>
When writing a component which can be activated through
-OAF by clients, you need to be register your component
-to OAF once it is created.
+Bonobo Activation by clients, you need to be register your component
+to Bonobo Activation once it is created.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -16,13 +16,13 @@
</para>
-<!-- ##### ENUM OAF_RegistrationResult ##### -->
+<!-- ##### ENUM Bonobo_RegistrationResult ##### -->
<para>
</para>
-<!-- ##### FUNCTION oaf_active_server_register ##### -->
+<!-- ##### FUNCTION bonobo_activation_active_server_register ##### -->
<para>
</para>
@@ -32,7 +32,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_active_server_unregister ##### -->
+<!-- ##### FUNCTION bonobo_activation_active_server_unregister ##### -->
<para>
</para>
@@ -41,11 +41,11 @@
@obj:
-<!-- ##### STRUCT OAFPlugin ##### -->
+<!-- ##### STRUCT BonoboActivationPlugin ##### -->
<para>
Components which want to be activated as
-shared libraries must export an OAFPlugin
-structure of name <structname>OAF_Plugin_info</structname>.
+shared libraries must export an BonoboActivationPlugin
+structure of name <structname>BonoboActivation_Plugin_info</structname>.
An exmaple of how to use it folows:
<programlisting>
static CORBA_Object
@@ -63,12 +63,12 @@
return CORBA_OBJECT_NIL;
}
- oaf_plugin_use (poa, impl_ptr);
+ bonobo_activation_plugin_use (poa, impl_ptr);
return object_ref;
}
-static const OAFPluginObject hi_plugin_list[] = {
+static const BonoboActivationPluginObject hi_plugin_list[] = {
{
"OAFIID:Hi:20000923",
hi_shlib_make_object
@@ -78,7 +78,7 @@
}
};
-const OAFPlugin OAF_Plugin_info = {
+const BonoboActivationPlugin BonoboActivation_Plugin_info = {
hi_plugin_list,
"Hi example"
};
@@ -86,13 +86,13 @@
</para>
-<!-- ##### STRUCT OAFPluginObject ##### -->
+<!-- ##### STRUCT BonoboActivationPluginObject ##### -->
<para>
</para>
-<!-- ##### FUNCTION oaf_plugin_use ##### -->
+<!-- ##### FUNCTION bonobo_activation_plugin_use ##### -->
<para>
</para>
@@ -101,7 +101,7 @@
@impl_ptr:
-<!-- ##### FUNCTION oaf_plugin_unuse ##### -->
+<!-- ##### FUNCTION bonobo_activation_plugin_unuse ##### -->
<para>
</para>
Index: api-docs/tmpl/utilities.sgml
===================================================================
RCS file: /cvs/gnome/bonobo-activation/api-docs/tmpl/utilities.sgml,v
retrieving revision 1.3
diff -u -r1.3 utilities.sgml
--- api-docs/tmpl/utilities.sgml 2000/10/25 18:22:47 1.3
+++ api-docs/tmpl/utilities.sgml 2001/11/28 13:49:59
@@ -2,7 +2,7 @@
Utilities
<!-- ##### SECTION Short_Description ##### -->
-Random misc utilities to manipulate OAF_ServerInfo structures.
+Random misc utilities to manipulate Bonobo_ServerInfo structures.
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -14,25 +14,25 @@
</para>
-<!-- ##### STRUCT OAF_Property ##### -->
+<!-- ##### STRUCT BonoboActivation_Property ##### -->
<para>
</para>
-<!-- ##### STRUCT OAF_PropertyValue ##### -->
+<!-- ##### STRUCT BonoboActivation_PropertyValue ##### -->
<para>
</para>
-<!-- ##### ENUM OAF_PropertyType ##### -->
+<!-- ##### ENUM BonoboActivation_PropertyType ##### -->
<para>
</para>
-<!-- ##### FUNCTION oaf_server_info_prop_find ##### -->
+<!-- ##### FUNCTION bonobo_server_info_prop_find ##### -->
<para>
</para>
@@ -48,7 +48,7 @@
</para>
-<!-- ##### FUNCTION oaf_actinfo_stringify ##### -->
+<!-- ##### FUNCTION bonobo_activation_info_stringify ##### -->
<para>
</para>
@@ -57,7 +57,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_servinfo_to_actinfo ##### -->
+<!-- ##### FUNCTION bonobo_activation_servinfo_to_actinfo ##### -->
<para>
</para>
@@ -66,7 +66,7 @@
@Returns:
-<!-- ##### FUNCTION oaf_actid_parse ##### -->
+<!-- ##### FUNCTION bonobo_activation_id_parse ##### -->
<para>
</para>
@@ -75,15 +75,23 @@
@Returns:
-<!-- ##### FUNCTION oaf_actinfo_free ##### -->
+<!-- ##### FUNCTION bonobo_activation_info_new ##### -->
<para>
</para>
+ Returns:
+
+
+<!-- ##### FUNCTION bonobo_activation_info_free ##### -->
+<para>
+
+</para>
+
@actinfo:
-<!-- ##### FUNCTION OAF_ServerInfo_duplicate ##### -->
+<!-- ##### FUNCTION Bonobo_ServerInfo_duplicate ##### -->
<para>
</para>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
