![]() |
![]() |
![]() |
![]() |
gpointer | client | Write / Construct Only |
char * | certificate-chain | Read / Write |
gboolean | disable-server-verification | Read / Write |
char * | override-host-name | Read / Write |
char * | private-key | Read / Write |
char * | tls-root-certificates | Read / Write |
gint64 | write-size-limit-bytes | Read / Write |
#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 |
GObject ├── GAFlightRecordBatchReader │ ╰── GAFlightStreamReader ├── GAFlightCallOptions ├── GAFlightClient ╰── GAFlightClientOptions
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.
void gaflight_call_options_add_header (GAFlightCallOptions *options
,const gchar *name
,const gchar *value
);
Add a header.
Since: 9.0.0
void
gaflight_call_options_clear_headers (GAFlightCallOptions *options
);
Clear all headers.
Since: 9.0.0
void gaflight_call_options_foreach_header (GAFlightCallOptions *options
,GAFlightHeaderFunc func
,gpointer user_data
);
Iterates over all headers in the options.
options |
||
func |
The user's callback function. |
[scope call] |
user_data |
Data for |
[closure] |
Since: 9.0.0
GAFlightClientOptions *
gaflight_client_options_new (void
);
Since: 5.0.0
GAFlightClient * gaflight_client_new (GAFlightLocation *location
,GAFlightClientOptions *options
,GError **error
);
Since: 5.0.0
gboolean gaflight_client_close (GAFlightClient *client
,GError **error
);
Since: 8.0.0
gboolean gaflight_client_authenticate_basic_token (GAFlightClient *client
,const gchar *user
,const gchar *password
,GAFlightCallOptions *options
,gchar **bearer_name
,gchar **bearer_value
,GError **error
);
Authenticates to the server using basic HTTP style authentication.
client |
||
user |
User name to be used. |
|
password |
Password to be used. |
|
options |
[nullable] | |
bearer_name |
Bearer token name on success. |
[out][transfer full] |
bearer_value |
Bearer token value on success. |
[out][transfer full] |
error |
[nullable] |
Since: 12.0.0
GList * gaflight_client_list_flights (GAFlightClient *client
,GAFlightCriteria *criteria
,GAFlightCallOptions *options
,GError **error
);
The returned list of GAFlightInfo on success, NULL
on error.
[nullable][element-type GAFlightInfo][transfer full]
Since: 5.0.0
GAFlightInfo * gaflight_client_get_flight_info (GAFlightClient *client
,GAFlightDescriptor *descriptor
,GAFlightCallOptions *options
,GError **error
);
client |
||
descriptor |
A GAFlightDescriptor to be processed. |
|
options |
[nullable] | |
error |
[nullable] |
Since: 9.0.0
GAFlightStreamReader * gaflight_client_do_get (GAFlightClient *client
,GAFlightTicket *ticket
,GAFlightCallOptions *options
,GError **error
);
The GAFlightStreamReader to read record batched from the server
on success, NULL
on error.
[nullable][transfer full]
Since: 6.0.0
struct GAFlightStreamReaderClass { GAFlightRecordBatchReaderClass parent_class; };
“client”
property“client” gpointer
The raw std::shared_ptr<arrow::flight::FlightClient>.
Owner: GAFlightClient
Flags: Write / Construct Only
“certificate-chain”
property“certificate-chain” char *
The client certificate to use if using Mutual TLS.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: ""
Since: 14.0.0
“disable-server-verification”
property“disable-server-verification” gboolean
Whether use TLS without validating the server certificate. Use with caution.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: FALSE
Since: 9.0.0
“override-host-name”
property“override-host-name” char *
Override the host name checked by TLS. Use with caution.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: ""
Since: 14.0.0
“private-key”
property“private-key” char *
The private key associated with the client certificate for Mutual TLS.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: ""
Since: 14.0.0
“tls-root-certificates”
property“tls-root-certificates” char *
Root certificates to use for validating server certificates.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: ""
Since: 14.0.0
“write-size-limit-bytes”
property“write-size-limit-bytes” gint64
A soft limit on the number of bytes to write in a single batch when sending Arrow data to a server.
Used to help limit server memory consumption. Only enabled if
positive. When enabled, GARROW_ERROR_IO
may be yielded.
Owner: GAFlightClientOptions
Flags: Read / Write
Default value: 0
Since: 14.0.0