GNOME CORBA Framework
<<< Previous Page | Home | Up | Next Page >>>

# gnorba

## Name

gnorba -- Utility routines for making CORBA use easy within GNOME applications.

## Synopsis

    enum        GnorbaInitFlags;
    CORBA_ORB   gnome_CORBA_init                (const char *app_id,
                                                 const char *app_version,
                                                 int *argc,
                                                 char **argv,
                                                 GnorbaInitFlags gnorba_flags,
                                                 CORBA_Environment *ev);
    CORBA_ORB   gnome_CORBA_init_with_popt_table
                                                (const char *app_id,
                                                 const char *app_version,
                                                 int *argc,
                                                 char **argv,
                                                 const struct poptOption *options,
                                                 int popt_flags,
                                                 poptContext *return_ctx,
                                                 GnorbaInitFlags gnorba_flags,
                                                 CORBA_Environment *ev);
    CORBA_ORB   gnome_CORBA_ORB                 (void);
    CORBA_ORB   gnorba_CORBA_init               (int *argc,
                                                 char **argv,
                                                 GnorbaInitFlags flags,
                                                 CORBA_Environment *ev);
    CORBA_Object gnome_name_service_get         (void);

## Description

The gnorba routines relate to making basic use of CORBA in a GNOME application. This covers integrating the ORBit main loop with glib, adding basic security to CORBA connections, and accessing the CORBA name service for the session.

## Details

### enum GnorbaInitFlags

    typedef enum {
      GNORBA_INIT_SERVER_FUNC = 1 << 0,
      GNORBA_INIT_DISABLE_COOKIES = 1 << 1
    } GnorbaInitFlags;

- GNORBA_INIT_SERVER_FUNC specifies that this program intends to export implementations of CORBA objects to other programs

- GNORBA_INIT_DISABLE_COOKIES turns off the GNOME CORBA security mechanism

### gnome_CORBA_init ()

    CORBA_ORB   gnome_CORBA_init                (const char *app_id,
                                                 const char *app_version,
                                                 int *argc,
                                                 char **argv,
                                                 GnorbaInitFlags gnorba_flags,
                                                 CORBA_Environment *ev);

Wrapper around the GNORBA CORBA support routines for GNOME applications. This routine takes care of calling gnome_init after registering our command line arguments. After gnome_init is invoked, the GNORBA CORBA setup is bootstrapped by calling gnorba_CORBA_init for you.

`app_id` : | Application id.
`app_version` : | Application version.
`argc` : | pointer to argc (for example, as received by main)
`argv` : | pointer to argv (for example, as received by main)
`gnorba_flags` : | GNORBA initialization flags.
`ev` : | CORBA Environment to return CORBA errors.
Returns : | the CORBA_ORB for this application.

### gnome_CORBA_init_with_popt_table ()

    CORBA_ORB   gnome_CORBA_init_with_popt_table
                                                (const char *app_id,
                                                 const char *app_version,
                                                 int *argc,
                                                 char **argv,
                                                 const struct poptOption *options,
                                                 int popt_flags,
                                                 poptContext *return_ctx,
                                                 GnorbaInitFlags gnorba_flags,
                                                 CORBA_Environment *ev);

Wrapper around the GNORBA CORBA support routines for GNOME applications. This routine takes care of calling gnome_init after registering our command line arguments. After gnome_init is invoked, the GNORBA CORBA setup is bootstrapped by calling gnorba_CORBA_init for you.

This differs from gnome_CORBA_init only in that it provides a way to pass a table of popt options for argument parsing.

If you pass return_ctx, you need to release it with the proper popt routine where you are done.

`app_id` : | Application id.
`app_version` : | Application version.
`argc` : | pointer to argc (for example, as received by main)
`argv` : | argv (for example, as received by main)
`options` : | an array of poptOptions.
`popt_flags` : | flags passes to popt.
`return_ctx` : | if non-NULL a popt context is returned here.
`gnorba_flags` : | GNORBA initialization flags.
`ev` : | CORBA Environment to return CORBA errors.
Returns : | the CORBA_ORB for this application.

### gnome_CORBA_ORB ()

    CORBA_ORB   gnome_CORBA_ORB                 (void);

Returns : | the CORBA_ORB initialized by the GNORBA libraries.

### gnorba_CORBA_init ()

    CORBA_ORB   gnorba_CORBA_init               (int *argc,
                                                 char **argv,
                                                 GnorbaInitFlags flags,
                                                 CORBA_Environment *ev);

Sets up the ORBit connection add/remove function pointers to our routines, which inform the gtk main loop about the CORBA connection fd's.

Calls gnome_init and CORBA_ORB_init with the specified params.

Sets up a cookie for requests.

`argc` : | argc pointer from the application
`argv` : | argv from the application
`flags` : | GnorbaInitFlags that control the way we startup
`ev` : | A CORBA_Environment for catching CORBA errors
Returns : | the CORBA_ORB initialized by the GNORBA libraries.

### gnome_name_service_get ()

    CORBA_Object gnome_name_service_get         (void);

This routine returns an object reference to the name server for this user/session pair. This launches the name server if it is the first application running it.

Returns : | an object reference to the name service.

<<< Previous Page | Home | Up | Next Page >>>
libgnorba | goad