Client related classes: Apache Arrow Flight GLib Reference Manual

Client related classes

Functions

GAFlightCallOptions *	gaflight_call_options_new ()
GAFlightClientOptions *	gaflight_client_options_new ()
GAFlightClient *	gaflight_client_new ()
gboolean	gaflight_client_close ()
GList *	gaflight_client_list_flights ()
GAFlightStreamReader *	gaflight_client_do_get ()

Properties

gpointer

client

Write / Construct Only

Types and Values

#define	GAFLIGHT_TYPE_STREAM_READER
struct	GAFlightStreamReaderClass
#define	GAFLIGHT_TYPE_CALL_OPTIONS
struct	GAFlightCallOptionsClass
#define	GAFLIGHT_TYPE_CLIENT_OPTIONS
struct	GAFlightClientOptionsClass
#define	GAFLIGHT_TYPE_CLIENT
struct	GAFlightClientClass
	GAFlightCallOptions
	GAFlightClient
	GAFlightClientOptions
	GAFlightStreamReader

Object Hierarchy

    GObject
    ├── GAFlightRecordBatchReader
    │   ╰── GAFlightStreamReader
    ├── GAFlightCallOptions
    ├── GAFlightClient
    ╰── GAFlightClientOptions

Includes

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

Description

GAFlightStreamReader is a class for reading record batches from a server.

GAFlightCallOptions is a class for options of each call.

GAFlightClientOptions is a class for options of each client.

GAFlightClient is a class for Apache Arrow Flight client.

Functions

gaflight_call_options_new ()

GAFlightCallOptions *
gaflight_call_options_new (void);

Returns

The newly created options for a call.

Since: 5.0.0

gaflight_client_options_new ()

GAFlightClientOptions *
gaflight_client_options_new (void);

Returns

The newly created options for a client.

Since: 5.0.0

gaflight_client_new ()

GAFlightClient *
gaflight_client_new (GAFlightLocation *location,
                     GAFlightClientOptions *options,
                     GError **error);

Parameters

location	A GAFlightLocation to be connected.
options	A GAFlightClientOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The newly created client, NULL on error.

[nullable]

Since: 5.0.0

gaflight_client_close ()

gboolean
gaflight_client_close (GAFlightClient *client,
                       GError **error);

Parameters

client	A GAFlightClient.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE if there was an error.

Since: 8.0.0

gaflight_client_list_flights ()

GList *
gaflight_client_list_flights (GAFlightClient *client,
                              GAFlightCriteria *criteria,
                              GAFlightCallOptions *options,
                              GError **error);

Parameters

client	A GAFlightClient.
criteria	A GAFlightCriteria.	[nullable]
options	A GAFlightCallOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The returned list of GAFlightInfo on success, NULL on error.

[nullable][element-type GAFlightInfo][transfer full]

Since: 5.0.0

gaflight_client_do_get ()

GAFlightStreamReader *
gaflight_client_do_get (GAFlightClient *client,
                        GAFlightTicket *ticket,
                        GAFlightCallOptions *options,
                        GError **error);

Parameters

client	A GAFlightClient.
ticket	A GAFlightTicket.
options	A GAFlightCallOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GAFlightStreamReader to read record batched from the server on success, NULL on error.

[nullable][transfer full]

Since: 6.0.0

Types and Values

GAFLIGHT_TYPE_STREAM_READER

#define             GAFLIGHT_TYPE_STREAM_READER

struct GAFlightStreamReaderClass

struct GAFlightStreamReaderClass {
  GAFlightRecordBatchReaderClass parent_class;
};

GAFLIGHT_TYPE_CALL_OPTIONS

#define GAFLIGHT_TYPE_CALL_OPTIONS (gaflight_call_options_get_type())

struct GAFlightCallOptionsClass

struct GAFlightCallOptionsClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_CLIENT_OPTIONS

#define GAFLIGHT_TYPE_CLIENT_OPTIONS (gaflight_client_options_get_type())

struct GAFlightClientOptionsClass

struct GAFlightClientOptionsClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_CLIENT

#define GAFLIGHT_TYPE_CLIENT (gaflight_client_get_type())

struct GAFlightClientClass

struct GAFlightClientClass {
  GObjectClass parent_class;
};

GAFlightCallOptions

typedef struct _GAFlightCallOptions GAFlightCallOptions;

GAFlightClient

typedef struct _GAFlightClient GAFlightClient;

GAFlightClientOptions

typedef struct _GAFlightClientOptions GAFlightClientOptions;

GAFlightStreamReader

typedef struct _GAFlightStreamReader GAFlightStreamReader;

Property Details

The `“client”` property

  “client”                   gpointer

The raw arrow::flight::FlightClient *.

Owner: GAFlightClient

Flags: Write / Construct Only