CExternalDatasetAPI.h File Reference

#include <stddef.h>
#include "CExternalDataFileAPI.h"
#include "CExternalRandomAccessFileAPI.h"

Go to the source code of this file.

Classes
struct	CExternalDatasetCallbacksStruct

Typedefs
typedef struct CExternalDatasetStruct *	CExternalDatasetPtr
	Copyright 2014 Google Inc. More...
typedef CExternalDataFilePtr(*	CExternalFindFunctionPtr )(const char *serializedKey)
	Function type for callback to find a file by key. More...
typedef bool(*	CExternalAddFunctionPtr )(CExternalDataFilePtr file)
	Function type for callback to add a file. More...
typedef const char *(*	CExternalFileNameFunctionPtr )(const char *serializedKey)
	Function type for callback to get an output file name. More...
typedef bool(*	CExternalQueryOnlyFunctionPtr )()
	Function type for callback to ask if a dataset is query-only. More...
typedef CExternalRandomAccessFileSourcePtr(*	CExternalRandomAccessSourceFunctionPtr )(const char *serializedKey)
	Function type for callback to provide read-only random access to a file Returns null if no such file. More...
typedef CExternalRandomAccessFileSinkPtr(*	CExternalRandomAccessSinkFunctionPtr )(const char *serializedKey)
	Function type for callback to provide writable random access to a file Returns null if no such file. More...
typedef struct CExternalDatasetCallbacksStruct	CExternalDatasetCallbacks

Functions
CExternalDatasetPtr	CExternalDataset_newDataset (const char *name, const CExternalDatasetCallbacks &callbacks)
	Copyright 2014 Google Inc. More...
const char *	CExternalDataset_getName (CExternalDatasetPtr datasetHandle)
const char *	CExternalDataset_getSerializedDataset (CExternalDatasetPtr datasetHandle)
void	CExternalDataset_setSerializedDataset (CExternalDatasetPtr datasetHandle, const char *serializedDataset)
void	CExternalDataset_addDataFile (CExternalDatasetPtr datasetHandle, CExternalDataFilePtr fileHandle)
CExternalDataFilePtr	CExternalDataset_getDataFile (CExternalDatasetPtr datasetHandle, int index)
size_t	CExternalDataset_getFileCount (CExternalDatasetPtr datasetHandle)

Typedef Documentation

typedef bool(* CExternalAddFunctionPtr)(CExternalDataFilePtr file)

Function type for callback to add a file.

If the file has a source, data will be written from the source. Otherwise, a sink will be added to the file. File will be added to dataset. Returns false if the add failed

typedef struct CExternalDatasetCallbacksStruct CExternalDatasetCallbacks

typedef struct CExternalDatasetStruct* CExternalDatasetPtr

Copyright 2014 Google Inc.

All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

typedef const char*(* CExternalFileNameFunctionPtr)(const char *serializedKey)

Function type for callback to get an output file name.

typedef CExternalDataFilePtr(* CExternalFindFunctionPtr)(const char *serializedKey)

Function type for callback to find a file by key.

File will be added to dataset if found. Returns null if no such file

typedef bool(* CExternalQueryOnlyFunctionPtr)()

Function type for callback to ask if a dataset is query-only.

typedef CExternalRandomAccessFileSinkPtr(* CExternalRandomAccessSinkFunctionPtr)(const char *serializedKey)

Function type for callback to provide writable random access to a file Returns null if no such file.

typedef CExternalRandomAccessFileSourcePtr(* CExternalRandomAccessSourceFunctionPtr)(const char *serializedKey)

Function type for callback to provide read-only random access to a file Returns null if no such file.

Function Documentation

void CExternalDataset_addDataFile	(	CExternalDatasetPtr	datasetHandle,
		CExternalDataFilePtr	fileHandle
	)

CExternalDataFilePtr CExternalDataset_getDataFile	(	CExternalDatasetPtr	datasetHandle,
		int	index
	)

size_t CExternalDataset_getFileCount

(

CExternalDatasetPtr

datasetHandle

)

const char* CExternalDataset_getName

(

CExternalDatasetPtr

datasetHandle

)

const char* CExternalDataset_getSerializedDataset

(

CExternalDatasetPtr

datasetHandle

)

CExternalDatasetPtr CExternalDataset_newDataset	(	const char *	name,
		const CExternalDatasetCallbacks &	callbacks
	)

Copyright 2014 Google Inc.

All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

void CExternalDataset_setSerializedDataset	(	CExternalDatasetPtr	datasetHandle,
		const char *	serializedDataset
	)