Server related classes

Server related classes

Functions

Properties

gpointer call-context Write / Construct Only
GAFlightLocation * location Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ├── GAFlightServer
    ├── GAFlightServerCallContext
    ╰── GAFlightServerOptions

Includes

#include <arrow-flight-glib/arrow-flight-glib.h>

Description

GAFlightServerOptions is a class for options of each server.

GAFlightServer is a class to develop an Apache Arrow Flight server.

Functions

gaflight_server_options_new ()

GAFlightServerOptions *
gaflight_server_options_new (GAFlightLocation *location);

Parameters

location

A GAFlightLocation to be listened.

 

Returns

The newly created options for a server.

Since: 5.0.0


gaflight_server_listen ()

gboolean
gaflight_server_listen (GAFlightServer *server,
                        GAFlightServerOptions *options,
                        GError **error);

Parameters

server

A GAFlightServer.

 

options

A GAFlightServerOptions.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 5.0.0


gaflight_server_get_port ()

gint
gaflight_server_get_port (GAFlightServer *server);

gaflight_server_shutdown ()

gboolean
gaflight_server_shutdown (GAFlightServer *server,
                          GError **error);

Shuts down the serve. This function can be called from signal handler or another thread while gaflight_server_serve() blocks.

Parameters

server

A GAFlightServer.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 5.0.0


gaflight_server_wait ()

gboolean
gaflight_server_wait (GAFlightServer *server,
                      GError **error);

gaflight_server_list_flights ()

GList *
gaflight_server_list_flights (GAFlightServer *server,
                              GAFlightServerCallContext *context,
                              GAFlightCriteria *criteria,
                              GError **error);

Shuts down the serve. This function can be called from signal handler or another thread while gaflight_server_serve() blocks.

Parameters

server

A GAFlightServer.

 

context

A GAFlightServerCallContext.

 

criteria

A GAFlightCriteria.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

GList of GAFlightInfo on success, NULL on error.

[element-type GAFlightInfo][transfer full]

Since: 5.0.0

Types and Values

GAFLIGHT_TYPE_SERVER_OPTIONS

#define GAFLIGHT_TYPE_SERVER_OPTIONS (gaflight_server_options_get_type())

struct GAFlightServerOptionsClass

struct GAFlightServerOptionsClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_SERVER_CALL_CONTEXT

#define             GAFLIGHT_TYPE_SERVER_CALL_CONTEXT

struct GAFlightServerCallContextClass

struct GAFlightServerCallContextClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_SERVER

#define GAFLIGHT_TYPE_SERVER (gaflight_server_get_type())

struct GAFlightServerClass

struct GAFlightServerClass {
  GObjectClass parent_class;

  GList *(*list_flights)(GAFlightServer *server,
                         GAFlightServerCallContext *context,
                         GAFlightCriteria *criteria,
                         GError **error);
};

GAFlightServer

typedef struct _GAFlightServer GAFlightServer;

GAFlightServerCallContext

typedef struct _GAFlightServerCallContext GAFlightServerCallContext;

GAFlightServerOptions

typedef struct _GAFlightServerOptions GAFlightServerOptions;

Property Details

The “call-context” property

  “call-context”             gpointer

The raw arrow::flight::ServerCallContext.

Owner: GAFlightServerCallContext

Flags: Write / Construct Only


The “location” property

  “location”                 GAFlightLocation *

The location to be listened.

Owner: GAFlightServerOptions

Flags: Read / Write / Construct Only