Top Description Methods
com.github.luben.zstd

public Interface SequenceProducer

Interface for an extenal sequence producer. To register a sequence producer, pass an object implementing this interface to ZstdCompressCtx#registerSequenceProducer(SequenceProducer).

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

A void * pointer to the sequence producer state
createState()

Allocate the sequence producer state.

public void
freeState(long
the state pointer to be freed
statePointer)

Free the sequence producer state.

public long

Returns:

A function pointer of type ZSTD_sequenceProducer_F *
getFunctionPointer()

Returns a pointer to the sequence producer function.

Method Detail

createStateback to summary
public long createState()

Allocate the sequence producer state. The returned pointer will be passed to the sequence producer function. This method is called once in ZstdCompressCtx#registerSequenceProducer(SequenceProducer).

Returns:long

A void * pointer to the sequence producer state

freeStateback to summary
public void freeState(long statePointer)

Free the sequence producer state. This method is called when closing the ZstdCompressCtx or registering a different sequence producer.

Parameters
statePointer:long

the state pointer to be freed

getFunctionPointerback to summary
public long getFunctionPointer()

Returns a pointer to the sequence producer function. This method is called once in ZstdCompressCtx#registerSequenceProducer(SequenceProducer).

Returns:long

A function pointer of type ZSTD_sequenceProducer_F *