Uses of Class
org.apache.arrow.vector.ipc.message.IpcOption

Packages that use IpcOption

Package	Description
org.apache.arrow.flight
org.apache.arrow.vector.ipc
org.apache.arrow.vector.ipc.message

Uses of IpcOption in org.apache.arrow.flight

Methods in org.apache.arrow.flight with parameters of type IpcOption

Modifier and Type	Method	Description
FlightInfo.Builder	FlightInfo.Builder.setOption(IpcOption option)	Set IPC write options.
void	OutboundStreamListener.start(VectorSchemaRoot root, DictionaryProvider dictionaries, IpcOption option)	Start sending data, using the schema of the given VectorSchemaRoot.

Constructors in org.apache.arrow.flight with parameters of type IpcOption

Modifier	Constructor	Description
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, boolean ordered, IpcOption option)	Constructs a new instance.
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, boolean ordered, IpcOption option, byte[] appMetadata)	Constructs a new instance.
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, IpcOption option)	Constructs a new instance.
	SchemaResult(Schema schema, IpcOption option)	Create a schema result with specific IPC options for serialization.

Uses of IpcOption in org.apache.arrow.vector.ipc

Fields in org.apache.arrow.vector.ipc declared as IpcOption

Modifier and Type	Field	Description
protected IpcOption	ArrowWriter.option

Methods in org.apache.arrow.vector.ipc with parameters of type IpcOption

Modifier and Type	Method	Description
static void	ArrowStreamWriter.writeEndOfStream(WriteChannel out, IpcOption option)	Write an EOS identifier to the WriteChannel.

Constructors in org.apache.arrow.vector.ipc with parameters of type IpcOption

Modifier	Constructor	Description
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)	Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType)	Construct an ArrowStreamWriter with compression enabled.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)	Construct an ArrowStreamWriter with compression enabled.
protected	ArrowWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)
protected	ArrowWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)	Note: fields are not closed when the writer is closed.

Uses of IpcOption in org.apache.arrow.vector.ipc.message

Fields in org.apache.arrow.vector.ipc.message declared as IpcOption

Modifier and Type	Field	Description
static final IpcOption	IpcOption.DEFAULT

Methods in org.apache.arrow.vector.ipc.message with parameters of type IpcOption

Modifier and Type	Method	Description
static ArrowBlock	MessageSerializer.serialize(WriteChannel out, ArrowDictionaryBatch batch, IpcOption option)	Serializes a dictionary ArrowRecordBatch.
static ArrowBlock	MessageSerializer.serialize(WriteChannel out, ArrowRecordBatch batch, IpcOption option)	Serializes an ArrowRecordBatch.
static long	MessageSerializer.serialize(WriteChannel out, Schema schema, IpcOption option)	Serialize a schema object.
static ByteBuffer	MessageSerializer.serializeMessage(com.google.flatbuffers.FlatBufferBuilder builder, byte headerType, int headerOffset, long bodyLength, IpcOption writeOption)	Serializes a message header.
static ByteBuffer	MessageSerializer.serializeMetadata(ArrowMessage message, IpcOption writeOption)	Returns the serialized form of RecordBatch wrapped in a Message.
static ByteBuffer	MessageSerializer.serializeMetadata(Schema schema, IpcOption writeOption)	Returns the serialized flatbuffer bytes of the schema wrapped in a message table.
static int	MessageSerializer.writeMessageBuffer(WriteChannel out, int messageLength, ByteBuffer messageBuffer, IpcOption option)	Write the serialized Message metadata, prefixed by the length, to the output Channel.