pitrou commented on a change in pull request #10125:
URL: https://github.com/apache/arrow/pull/10125#discussion_r617745939
##########
File path: cpp/src/arrow/c/abi.h
##########
@@ -98,6 +98,116 @@ struct ArrowArrayStream {
void* private_data;
};
+// EXPERIMENTAL: C push producer interface
+
+// Consumer-provided callbacks for push producers
+//
+// Rules:
+// - any of these callbacks may be called concurrently from multiple threads
+// - any of these callbacks may call back into
+// `ArrowArrayProducer::pause_producing`,
`ArrowArrayProducer::resume_producing`
+// or `ArrowArrayProducer::stop_producing`
+// (but *not* into `ArrowArrayProducer::release`).
+struct ArrowArrayReceiver {
+ // The producer calls this callback to push a data item after it
+ // has filled the pointer-passed ArrowArray struct.
+ //
+ // The consumer *must* move the ArrowArray struct contents before this
+ // callback returns, as the producer is free to release it immediately
+ // afterwards.
+ //
+ // This callback is allowed to call back any ArrowArrayProducer callback,
+ // except the `release` callback.
+ void (*receive_array)(struct ArrowArrayReceiver*, struct ArrowArray* out);
+
+ // The producer calls this callback to signal an error occurred while
+ // producing data.
+ //
+ // `error` is a non-zero `errno`-compatible error code.
+ //
+ // `message` is an optional null-terminated character array describing
+ // the error, or NULL if no description is available. The `message`
+ // pointer is only valid until this callback returns, therefore the
+ // consumer must copy its contents if it wants to store the error message.
+ //
+ // This callback is allowed to call back any ArrowArrayProducer callback,
+ // except the `release` callback.
+ void (*receive_error)(struct ArrowArrayReceiver*, int error, const char*
message);
+
+ // Opaque consumer-specific data.
+ //
+ // This is meant to help the consumer associate calls to the above
+ // callbacks to its internal structures. If such resources were
+ // dynamically allocated, they should only be released by the consumer
+ // after `ArrowArrayProducer::release` has been called and has returned.
+ void* private_data;
+};
+
+// Push-based array producer
+struct ArrowArrayProducer {
+ // Callback to get the produced data type
+ // (will be the same for all pushed arrays).
+ //
+ // The ArrowSchema must be released independently from the ArrowArrayProducer
+ //
+ // XXX add error return?
+ void (*get_schema)(struct ArrowArrayProducer*, struct ArrowSchema* out);
Review comment:
Once before `start_producing`. I'm not sure this is necessary.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
