Defines editable stream callback functions. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/stream_cc.h"

Include dependency graph for editable_stream_cc.h:

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_editable_stream

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateEditableStream(const mip_cc_stream_insert_callback_fn insertCallback
	Creates a stream.

	MIP_CC_API (void) MIP_CC_ReleaseEditableStream(mip_cc_editable_stream stream)
	Release resources associated with an editable stream handle.

	MIP_CC_CALLBACK (mip_cc_stream_delete_callback_fn, int64_t, void *context, int64_t numBytes)
	Callback function definition for deleting bytes from the stream.

	MIP_CC_CALLBACK (mip_cc_stream_insert_callback_fn, int64_t, void context, const uint8_t buffer, int64_t bufferLength)
	Callback function definition for inserting a buffer into the stream.

	MIP_CC_CALLBACK (mip_cc_stream_update_callback_fn, int64_t, void context, const uint8_t buffer, int64_t bufferLength, int64_t replaceLength)
	Callback function definition for updating the stream with a replacement buffer.

Variables
const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn	canReadCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn	canWriteCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn void *	context

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn	deleteCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn void mip_cc_editable_stream mip_cc_error *	errorInfo

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn	flushCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn	getSizeCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn	positionCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn	readCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn	seekCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn	setSizeCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn void mip_cc_editable_stream *	stream

const mip_cc_stream_update_callback_fn	updateCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn	writeCallback

Detailed Description

Defines editable stream callback functions.

Definition in file editable_stream_cc.h.

Typedef Documentation

◆ mip_cc_editable_stream

typedef mip_cc_handle* mip_cc_editable_stream

Definition at line 85 of file editable_stream_cc.h.

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Creates a stream.

Parameters

insertCallback	Function pointer for inserting into the stream from a buffer
updateCallback	Function pointer for updating the stream with a replacement buffer
deleteCallback	Function pointer for deleting bytes from the stream
readCallback	Function pointer for reading into a buffer from the stream
writeCallback	Function pointer for writeing into the stream from a buffer
flushCallback	Function pointer for writing a log statement
seekCallback	Function pointer for seeking specific position within the stream
canReadCallback	Function pointer for a check if stream can be read from
canWriteCallback	Function pointer for a check if stream can be written to
positionCallback	Function pointer for getting the current position within the stream
getSizeCallback	Function pointer for getting the size of the content within the stream
setSizeCallback	Function pointer for setting the stream size
context	Context that will be supplied to each callback function as the first arg. Should remain valid for the lifetime of the stream
stream	[Output] Handle to stream object
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

◆ MIP_CC_API() [2/2]

MIP_CC_API ( void )

Release resources associated with an editable stream handle.

Parameters

stream stream to be released

◆ MIP_CC_CALLBACK() [1/3]

MIP_CC_CALLBACK	(	mip_cc_stream_delete_callback_fn	,
		int64_t	,
		void *	context,
		int64_t	numBytes )

Callback function definition for deleting bytes from the stream.

Parameters

context	user provided context
numBytes	number of bytes to replace.

Returns: number of bytes deleted.

◆ MIP_CC_CALLBACK() [2/3]

MIP_CC_CALLBACK	(	mip_cc_stream_insert_callback_fn	,
		int64_t	,
		void *	context,
		const uint8_t *	buffer,
		int64_t	bufferLength )

Callback function definition for inserting a buffer into the stream.

Parameters

context	user provided context
buffer	pointer to a buffer
bufferLength	buffer size.

Returns: number of bytes inserted.

◆ MIP_CC_CALLBACK() [3/3]

MIP_CC_CALLBACK	(	mip_cc_stream_update_callback_fn	,
		int64_t	,
		void *	context,
		const uint8_t *	buffer,
		int64_t	bufferLength,
		int64_t	replaceLength )

Callback function definition for updating the stream with a replacement buffer.

Parameters

context	user provided context
buffer	pointer to a buffer
bufferLength	buffer size.
replaceLength	number of bytes to replace.

Returns: number of bytes inserted.

Variable Documentation

◆ canReadCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn canReadCallback

Definition at line 116 of file editable_stream_cc.h.

◆ canWriteCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn canWriteCallback

Definition at line 117 of file editable_stream_cc.h.

◆ context

const mip_cc_document_state const mip_cc_application_action_state const void * context

Definition at line 121 of file editable_stream_cc.h.

◆ deleteCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn deleteCallback

Definition at line 111 of file editable_stream_cc.h.

◆ errorInfo

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn void mip_cc_editable_stream mip_cc_error* errorInfo

Definition at line 123 of file editable_stream_cc.h.

◆ flushCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn flushCallback

Definition at line 114 of file editable_stream_cc.h.

◆ getSizeCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn getSizeCallback

Definition at line 119 of file editable_stream_cc.h.

◆ positionCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn positionCallback

Definition at line 118 of file editable_stream_cc.h.

◆ readCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn readCallback

Definition at line 112 of file editable_stream_cc.h.

◆ seekCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn seekCallback

Definition at line 115 of file editable_stream_cc.h.

◆ setSizeCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn setSizeCallback

Definition at line 120 of file editable_stream_cc.h.

◆ stream

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn const mip_cc_stream_flush_callback_fn const mip_cc_stream_seek_callback_fn const mip_cc_stream_canread_callback_fn const mip_cc_stream_canwrite_callback_fn const mip_cc_stream_position_callback_fn const mip_cc_stream_getsize_callback_fn const mip_cc_stream_setsize_callback_fn void mip_cc_editable_stream* stream

Definition at line 122 of file editable_stream_cc.h.

◆ updateCallback

const mip_cc_stream_update_callback_fn updateCallback

Definition at line 110 of file editable_stream_cc.h.

◆ writeCallback

const mip_cc_stream_update_callback_fn const mip_cc_stream_delete_callback_fn const mip_cc_stream_read_callback_fn const mip_cc_stream_write_callback_fn writeCallback

Definition at line 113 of file editable_stream_cc.h.

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ mip_cc_editable_stream

Function Documentation

◆ MIP_CC_API() [1/2]

◆ MIP_CC_API() [2/2]

◆ MIP_CC_CALLBACK() [1/3]

◆ MIP_CC_CALLBACK() [2/3]

◆ MIP_CC_CALLBACK() [3/3]

Variable Documentation

◆ canReadCallback

◆ canWriteCallback

◆ context

◆ deleteCallback

◆ errorInfo

◆ flushCallback

◆ getSizeCallback

◆ positionCallback

◆ readCallback

◆ seekCallback

◆ setSizeCallback

◆ stream

◆ updateCallback

◆ writeCallback