include/razorback/block.h File Reference

Block functions. More...

#include <razorback/visibility.h>
#include <razorback/types.h>

Include dependency graph for block.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
SO_PUBLIC struct Block *	Block_Create (void)
	Constructs a block.
SO_PUBLIC void	Block_Destroy (struct Block *p_pBlock)
	Destroys a block id.
SO_PUBLIC struct Block *	Block_Clone (const struct Block *p_pSource)
	Copies a block id.
SO_PUBLIC uint32_t	Block_BinaryLength (struct Block *p_pBlock)
	Calculate the Wire Size of A Block.
SO_PUBLIC bool	Block_MetaData_Add (struct Block *block, uuid_t uuidName, uuid_t uuidType, uint8_t *data, uint32_t size)
	Add MetaData to a block.
SO_PUBLIC bool	Block_MetaData_Add_FileName (struct Block *block, const char *fileName)
	Add Filename MetaData to a block.

---

Detailed Description

Block functions.

---

Function Documentation

SO_PUBLIC uint32_t Block_BinaryLength

(

struct Block *

p_pBlock

)

Calculate the Wire Size of A Block.

Parameters:

the

block

Returns:

the size

SO_PUBLIC struct Block* Block_Clone

(

const struct Block *

p_pSource

)

[read]

Copies a block id.

Parameters:

	p_pDestination	the destination
	p_pSource	the source

SO_PUBLIC struct Block* Block_Create

(

void

)

[read]

Constructs a block.

Returns:

a new Block or NULL on error.

SO_PUBLIC void Block_Destroy

(

struct Block *

p_pBlock

)

Destroys a block id.

Parameters:

p_pBlockId

the block to destroy

SO_PUBLIC bool Block_MetaData_Add	(	struct Block *	block,
		uuid_t	uuidName,
		uuid_t	uuidType,
		uint8_t *	data,
		uint32_t	size
	)

Add MetaData to a block.

Parameters:

	block	The block to add metadata to.
	uuidName	The UUID of the metadata name
	uuidType	The UUID of the metadata data type.
	data	The data
	size	The size of the data.

Returns:

true on success false on error.

SO_PUBLIC bool Block_MetaData_Add_FileName	(	struct Block *	block,
		const char *	fileName
	)

Add Filename MetaData to a block.

Parameters:

	block	The block.
	fileName	The file name.

Returns:

true on success, false on error.