Classes both for client and server

Classes both for client and server

Functions

Properties

GBytes * expression Read / Write
gpointer descriptor Write / Construct Only
GAFlightTicket * ticket Read
gpointer info Write / Construct Only
GBytes * data Read / Write

Types and Values

Object Hierarchy

    GObject
    ├── GAFlightCriteria
    ├── GAFlightDescriptor
       ├── GAFlightCommandDescriptor
       ├── GAFlightPathDescriptor
       ╰── GAFlightCommandDescriptor
    ├── GAFlightEndpoint
    ├── GAFlightInfo
    ├── GAFlightLocation
    ╰── GAFlightTicket

Includes

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

Description

GAFlightCriteria is a class for criteria.

GAFlightLocation is a class for location.

GAFlightDescriptor is a base class for all descriptor classes such as GArrowFlightPathDescriptor.

GAFlightPathDescriptor is a class for path descriptor.

GAFlightCommandDescriptor is a class for command descriptor.

GAFlightTicket is a class for ticket.

GAFlightEndpoint is a class for endpoint.

GAFlightInfo is a class for flight information.

Functions

gaflight_criteria_new ()

GAFlightCriteria *
gaflight_criteria_new (GBytes *expression);

Parameters

expression

A GBytes.

 

Returns

The newly created GAFlightCriteria, NULL on error.

Since: 5.0.0


gaflight_location_new ()

GAFlightLocation *
gaflight_location_new (const gchar *uri,
                       GError **error);

Parameters

uri

An URI to specify location.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The newly created location, NULL on error.

[nullable]

Since: 5.0.0


gaflight_location_to_string ()

gchar *
gaflight_location_to_string (GAFlightLocation *location);

Parameters

location

A GAFlightLocation.

 

Returns

A representation of this URI as a string.

It should be freed with g_free() when no longer needed.

Since: 5.0.0


gaflight_location_get_scheme ()

gchar *
gaflight_location_get_scheme (GAFlightLocation *location);

Parameters

location

A GAFlightLocation.

 

Returns

The scheme of this URI.

It should be freed with g_free() when no longer needed.

Since: 5.0.0


gaflight_location_equal ()

gboolean
gaflight_location_equal (GAFlightLocation *location,
                         GAFlightLocation *other_location);

Parameters

location

A GAFlightLocation.

 

other_location

A GAFlightLocation to be compared.

 

Returns

TRUE if both of them represents the same URI, FALSE otherwise.

Since: 5.0.0


gaflight_descriptor_to_string ()

gchar *
gaflight_descriptor_to_string (GAFlightDescriptor *descriptor);

Parameters

descriptor

A GAFlightDescriptor.

 

Returns

A descriptor as a string.

It should be freed with g_free() when no longer needed.

Since: 5.0.0


gaflight_descriptor_equal ()

gboolean
gaflight_descriptor_equal (GAFlightDescriptor *descriptor,
                           GAFlightDescriptor *other_descriptor);

Parameters

descriptor

A GAFlightDescriptor.

 

other_descriptor

A GAFlightDescriptor to be compared.

 

Returns

TRUE if both of them represents the same descriptor, FALSE otherwise.

Since: 5.0.0


gaflight_path_descriptor_new ()

GAFlightPathDescriptor *
gaflight_path_descriptor_new (const gchar **paths,
                              gsize n_paths);

Parameters

paths

List of paths identifying a particular dataset.

[array length=n_paths]

n_paths

The number of paths .

 

Returns

The newly created GAFlightPathDescriptor.

Since: 5.0.0


gaflight_path_descriptor_get_paths ()

gchar **
gaflight_path_descriptor_get_paths (GAFlightPathDescriptor *descriptor);

Parameters

descriptor

A GAFlightPathDescriptor.

 

Returns

The paths in this descriptor.

It must be freed with g_strfreev() when no longer needed.

[nullable][array zero-terminated=1][transfer full]

Since: 5.0.0


gaflight_command_descriptor_new ()

GAFlightCommandDescriptor *
gaflight_command_descriptor_new (const gchar *command);

Parameters

command

Opaque value used to express a command.

 

Returns

The newly created GAFlightCommandDescriptor.

Since: 5.0.0


gaflight_command_descriptor_get_command ()

gchar *
gaflight_command_descriptor_get_command
                               (GAFlightCommandDescriptor *descriptor);

Parameters

descriptor

A GAFlightCommandDescriptor.

 

Returns

The opaque value used to express a command.

It should be freed with g_free() when no longer needed.

Since: 5.0.0


gaflight_ticket_new ()

GAFlightTicket *
gaflight_ticket_new (GBytes *data);

Parameters

data

A GBytes.

 

Returns

The newly created GAFlightTicket, NULL on error.

Since: 5.0.0


gaflight_ticket_equal ()

gboolean
gaflight_ticket_equal (GAFlightTicket *ticket,
                       GAFlightTicket *other_ticket);

Parameters

ticket

A GAFlightTicket.

 

other_ticket

A GAFlightTicket to be compared.

 

Returns

TRUE if both of them represents the same ticket, FALSE otherwise.

Since: 5.0.0


gaflight_endpoint_new ()

GAFlightEndpoint *
gaflight_endpoint_new (GAFlightTicket *ticket,
                       GList *locations);

Parameters

ticket

A GAFlightTicket.

 

locations

A list of GAFlightLocation.

[element-type GAFlightLocation]

Returns

The newly created GAFlightEndpoint, NULL on error.

Since: 5.0.0


gaflight_endpoint_equal ()

gboolean
gaflight_endpoint_equal (GAFlightEndpoint *endpoint,
                         GAFlightEndpoint *other_endpoint);

Parameters

endpoint

A GAFlightEndpoint.

 

other_endpoint

A GAFlightEndpoint to be compared.

 

Returns

TRUE if both of them represents the same endpoint, FALSE otherwise.

Since: 5.0.0


gaflight_endpoint_get_locations ()

GList *
gaflight_endpoint_get_locations (GAFlightEndpoint *endpoint);

Parameters

endpoint

A GAFlightEndpoint.

 

Returns

The locations in this endpoint.

It must be freed with g_list_free() and g_object_unref() when no longer needed. You can use g_list_free_full(locations, g_object_unref).

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

Since: 5.0.0


gaflight_info_new ()

GAFlightInfo *
gaflight_info_new (GArrowSchema *schema,
                   GAFlightDescriptor *descriptor,
                   GList *endpoints,
                   gint64 total_records,
                   gint64 total_bytes,
                   GError **error);

Parameters

schema

A GArrowSchema.

 

descriptor

A GAFlightDescriptor.

 

endpoints

A list of GAFlightEndpoint.

[element-type GAFlightEndpoint]

total_records

The number of total records.

 

total_bytes

The number of total bytes.

 

error

Return location for a GError or NULL.

[nullable]

Returns

The newly created GAFlightInfo, NULL on error.

[nullable]

Since: 5.0.0


gaflight_info_equal ()

gboolean
gaflight_info_equal (GAFlightInfo *info,
                     GAFlightInfo *other_info);

Parameters

info

A GAFlightInfo.

 

other_info

A GAFlightInfo to be compared.

 

Returns

TRUE if both of them represents the same information, FALSE otherwise.

Since: 5.0.0


gaflight_info_get_schema ()

GArrowSchema *
gaflight_info_get_schema (GAFlightInfo *info,
                          GArrowReadOptions *options,
                          GError **error);

Parameters

info

A GAFlightInfo.

 

options

A GArrowReadOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

Deserialized GArrowSchema, NULL on error.

[transfer full]

Since: 5.0.0


gaflight_info_get_descriptor ()

GAFlightDescriptor *
gaflight_info_get_descriptor (GAFlightInfo *info);

Parameters

info

A GAFlightInfo.

 

Returns

The GAFlightDescriptor of the information.

[transfer full]

Since: 5.0.0


gaflight_info_get_endpoints ()

GList *
gaflight_info_get_endpoints (GAFlightInfo *info);

Parameters

info

A GAFlightInfo.

 

Returns

The list of GAFlightEndpoint of the information.

[element-type GAFlightEndpoint][transfer full]

Since: 5.0.0


gaflight_info_get_total_records ()

gint64
gaflight_info_get_total_records (GAFlightInfo *info);

Parameters

info

A GAFlightInfo.

 

Returns

The number of total records of the information.

Since: 5.0.0


gaflight_info_get_total_bytes ()

gint64
gaflight_info_get_total_bytes (GAFlightInfo *info);

Parameters

info

A GAFlightInfo.

 

Returns

The number of total bytes of the information.

Since: 5.0.0

Types and Values

GAFLIGHT_TYPE_CRITERIA

#define GAFLIGHT_TYPE_CRITERIA (gaflight_criteria_get_type())

struct GAFlightCriteriaClass

struct GAFlightCriteriaClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_LOCATION

#define GAFLIGHT_TYPE_LOCATION (gaflight_location_get_type())

struct GAFlightLocationClass

struct GAFlightLocationClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_DESCRIPTOR

#define GAFLIGHT_TYPE_DESCRIPTOR (gaflight_descriptor_get_type())

struct GAFlightDescriptorClass

struct GAFlightDescriptorClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_PATH_DESCRIPTOR

#define GAFLIGHT_TYPE_PATH_DESCRIPTOR (gaflight_path_descriptor_get_type())

struct GAFlightPathDescriptorClass

struct GAFlightPathDescriptorClass {
  GAFlightDescriptorClass parent_class;
};

GAFLIGHT_TYPE_COMMAND_DESCRIPTOR

#define GAFLIGHT_TYPE_COMMAND_DESCRIPTOR (gaflight_command_descriptor_get_type())

struct GAFlightCommandDescriptorClass

struct GAFlightCommandDescriptorClass {
  GAFlightDescriptorClass parent_class;
};

GAFLIGHT_TYPE_TICKET

#define GAFLIGHT_TYPE_TICKET (gaflight_ticket_get_type())

struct GAFlightTicketClass

struct GAFlightTicketClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_ENDPOINT

#define GAFLIGHT_TYPE_ENDPOINT (gaflight_endpoint_get_type())

struct GAFlightEndpointClass

struct GAFlightEndpointClass {
  GObjectClass parent_class;
};

GAFLIGHT_TYPE_INFO

#define GAFLIGHT_TYPE_INFO (gaflight_info_get_type())

struct GAFlightInfoClass

struct GAFlightInfoClass {
  GObjectClass parent_class;
};

GAFlightCommandDescriptor

typedef struct _GAFlightCommandDescriptor GAFlightCommandDescriptor;

GAFlightCriteria

typedef struct _GAFlightCriteria GAFlightCriteria;

GAFlightDescriptor

typedef struct _GAFlightDescriptor GAFlightDescriptor;

GAFlightEndpoint

typedef struct _GAFlightEndpoint GAFlightEndpoint;

GAFlightInfo

typedef struct _GAFlightInfo GAFlightInfo;

GAFlightLocation

typedef struct _GAFlightLocation GAFlightLocation;

GAFlightPathDescriptor

typedef struct _GAFlightPathDescriptor GAFlightPathDescriptor;

GAFlightTicket

typedef struct _GAFlightTicket GAFlightTicket;

Property Details

The “expression” property

  “expression”               GBytes *

Opaque criteria expression, dependent on server implementation.

Owner: GAFlightCriteria

Flags: Read / Write

Since: 5.0.0


The “descriptor” property

  “descriptor”               gpointer

The raw arrow::flight::FlightDescriptor.

Owner: GAFlightDescriptor

Flags: Write / Construct Only


The “ticket” property

  “ticket”                   GAFlightTicket *

Opaque ticket identify; use with DoGet RPC.

Owner: GAFlightEndpoint

Flags: Read

Since: 5.0.0


The “info” property

  “info”                     gpointer

The raw arrow::flight::FlightInfo *.

Owner: GAFlightInfo

Flags: Write / Construct Only


The “data” property

  “data”                     GBytes *

Opaque identifier or credential to use when requesting a data stream with the DoGet RPC.

Owner: GAFlightTicket

Flags: Read / Write

Since: 5.0.0