| gpointer | stream | Write / Construct Only |
| GArrowRecordBatchReader * | reader | Read / Write / Construct Only |
| gpointer | handler | Write / Construct Only |
| gpointer | reader | Write / Construct Only |
| gpointer | sender | Write / Construct Only |
| gpointer | call-context | Write / Construct Only |
| GAFlightServerAuthHandler * | auth-handler | Read / Write |
| GAFlightLocation * | location | Read / Write / Construct Only |
GInterface ╰── GAFlightServable GObject ├── GAFlightRecordBatchReader │ ╰── GAFlightMessageReader ├── GAFlightDataStream │ ╰── GAFlightRecordBatchStream ├── GAFlightServer ├── GAFlightServerAuthHandler │ ╰── GAFlightServerCustomAuthHandler ├── GAFlightServerAuthReader ├── GAFlightServerAuthSender ├── GAFlightServerCallContext ╰── GAFlightServerOptions
GAFlightDataStream is a class for producing a sequence of IPC
payloads to be sent in FlightData protobuf messages. Generally,
this is not used directly. Generally, GAFlightRecordBatchStream is
used instead.
GAFlightRecordBatchStream is a class for producing a sequence of
IPC payloads to be sent in FlightData protobuf messages by
GArrowRecordBatchReader`.
GAFlightMessageReader is a class for IPC payloads uploaded by a client. Also allows reading application-defined metadata via the Flight protocol.
GAFlightServerAuthSender is a class for sending messages to the client during an authentication handshake.
GAFlightServerAuthReader is a class for reading messages from the client during an authentication handshake.
GAFlightServerAuthHandler is an abstract class to implement authentication for a Flight service.
GAFlightServerOptions is a class for options of each server.
GAFlightServerCallContext is a class for context of each server call.
GAFlightServer is a class to develop an Apache Arrow Flight server.
GAFlightRecordBatchStream * gaflight_record_batch_stream_new (GArrowRecordBatchReader *reader,GArrowWriteOptions *options);
reader |
A GArrowRecordBatchReader to be read. |
|
options |
A GArrowWriteOptions for writing record batches to a client. |
[nullable] |
Since: 6.0.0
GAFlightDescriptor *
gaflight_message_reader_get_descriptor
(GAFlightMessageReader *reader);
Since: 14.0.0
void gaflight_server_call_context_foreach_incoming_header (GAFlightServerCallContext *context,GAFlightHeaderFunc func,gpointer user_data);
Iterates over all incoming headers.
context |
||
func |
The user's callback function. |
[scope call] |
user_data |
Data for |
[closure] |
Since: 14.0.0
gboolean gaflight_server_auth_sender_write (GAFlightServerAuthSender *sender,GBytes *message,GError **error);
Writes a message to the client.
Since: 12.0.0
GBytes * gaflight_server_auth_reader_read (GAFlightServerAuthReader *reader,GError **error);
Reads a message from the client.
Since: 12.0.0
void gaflight_server_custom_auth_handler_authenticate (GAFlightServerCustomAuthHandler *handler,GAFlightServerCallContext *context,GAFlightServerAuthSender *sender,GAFlightServerAuthReader *reader,GError **error);
Authenticates the client on initial connection. The server can send and read responses from the client at any time.
Since: 12.0.0
GBytes * gaflight_server_custom_auth_handler_is_valid (GAFlightServerCustomAuthHandler *handler,GAFlightServerCallContext *context,GBytes *token,GError **error);
Validates a per-call client token.
handler |
||
context |
||
token |
The client token. May be the empty string if the client does not provide a token. |
|
error |
[nullable] |
The identity of the peer, if this authentication method supports it.
[nullable][transfer full]
Since: 12.0.0
GAFlightServerOptions *
gaflight_server_options_new (GAFlightLocation *location);
Since: 5.0.0
gboolean gaflight_server_listen (GAFlightServer *server,GAFlightServerOptions *options,GError **error);
Since: 5.0.0
gboolean gaflight_server_shutdown (GAFlightServer *server,GError **error);
Shuts down the serve. This function can be called from signal handler or another thread.
Since: 5.0.0
GList * gaflight_server_list_flights (GAFlightServer *server,GAFlightServerCallContext *context,GAFlightCriteria *criteria,GError **error);
Since: 5.0.0
GAFlightInfo * gaflight_server_get_flight_info (GAFlightServer *server,GAFlightServerCallContext *context,GAFlightDescriptor *request,GError **error);
Since: 9.0.0
GAFlightDataStream * gaflight_server_do_get (GAFlightServer *server,GAFlightServerCallContext *context,GAFlightTicket *ticket,GError **error);
Since: 6.0.0
struct GAFlightRecordBatchStreamClass {
GAFlightDataStreamClass parent_class;
};
struct GAFlightMessageReaderClass {
GAFlightRecordBatchReaderClass parent_class;
};
struct GAFlightServerCallContextClass {
GObjectClass parent_class;
};
struct GAFlightServerAuthSenderClass {
GObjectClass parent_class;
};
struct GAFlightServerAuthReaderClass {
GObjectClass parent_class;
};
struct GAFlightServerAuthHandlerClass {
GObjectClass parent_class;
};
struct GAFlightServerCustomAuthHandlerClass {
GAFlightServerAuthHandlerClass parent_class;
void (*authenticate)(GAFlightServerCustomAuthHandler *handler,
GAFlightServerCallContext *context,
GAFlightServerAuthSender *sender,
GAFlightServerAuthReader *reader,
GError **error);
GBytes *(*is_valid)(GAFlightServerCustomAuthHandler *handler,
GAFlightServerCallContext *context,
GBytes *token,
GError **error);
};
Since: 12.0.0
#define GAFLIGHT_TYPE_SERVER_OPTIONS (gaflight_server_options_get_type())
struct GAFlightServerClass {
GObjectClass parent_class;
GList *(*list_flights)(GAFlightServer *server,
GAFlightServerCallContext *context,
GAFlightCriteria *criteria,
GError **error);
GAFlightInfo *(*get_flight_info)(GAFlightServer *server,
GAFlightServerCallContext *context,
GAFlightDescriptor *request,
GError **error);
GAFlightDataStream *(*do_get)(GAFlightServer *server,
GAFlightServerCallContext *context,
GAFlightTicket *ticket,
GError **error);
};
Since: 5.0.0
“stream” property“stream” gpointer
The raw arrow::flight::FlightDataStream *.
Owner: GAFlightDataStream
Flags: Write / Construct Only
“reader” property“reader” GArrowRecordBatchReader *
The reader that produces record batches.
Owner: GAFlightRecordBatchStream
Flags: Read / Write / Construct Only
Since: 6.0.0
“handler” property“handler” gpointer
The raw std::shared_ptr<arrow::flight::ServerAuthHandler>.
Owner: GAFlightServerAuthHandler
Flags: Write / Construct Only
“reader” property“reader” gpointer
The raw arrow::flight::ServerAuthReader *.
Owner: GAFlightServerAuthReader
Flags: Write / Construct Only
“sender” property“sender” gpointer
The raw arrow::flight::ServerAuthSender *.
Owner: GAFlightServerAuthSender
Flags: Write / Construct Only
“call-context” property“call-context” gpointer
The raw arrow::flight::ServerCallContext.
Owner: GAFlightServerCallContext
Flags: Write / Construct Only
“auth-handler” property“auth-handler” GAFlightServerAuthHandler *
The authentication handler.
Owner: GAFlightServerOptions
Flags: Read / Write
Since: 12.0.0
“location” property“location” GAFlightLocation *
The location to be listened.
Owner: GAFlightServerOptions
Flags: Read / Write / Construct Only
Since: 5.0.0