net_file.h File Reference

#include "net.h"
#include "common.h"

Go to the source code of this file.

Typedefs
typedef struct KSI_FsClient_st	KSI_FsClient

Functions
int	KSI_FsClient_new (KSI_CTX *ctx, KSI_NetworkClient **client)
int	KSI_FsClient_setPublicationUrl (KSI_NetworkClient *client, const char *path)
int	KSI_FsClient_setExtender (KSI_NetworkClient *client, const char *path, const char *user, const char *pass)
int	KSI_FsClient_setAggregator (KSI_NetworkClient *client, const char *path, const char *user, const char *pass)
int	KSI_FsClient_extractPath (const char *uri, char **path)

Typedef Documentation

KSI_FsClient

typedef struct KSI_FsClient_st KSI_FsClient

Function Documentation

KSI_FsClient_extractPath()

int KSI_FsClient_extractPath	(	const char *	uri,
		char **	path
	)

Extract file path from URI

Parameters

[in]	uri	File URI.
[out]	path	Path to the file

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_FsClient_new()

int KSI_FsClient_new	(	KSI_CTX *	ctx,
		KSI_NetworkClient **	client
	)

Creates a new file system client.

Parameters

[in]	ctx	KSI context.
[out]	client	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_FsClient_setAggregator()

int KSI_FsClient_setAggregator	(	KSI_NetworkClient *	client,
		const char *	path,
		const char *	user,
		const char *	pass
	)

Setter for the file system aggregator parameters.

Parameters

[in]	client	Pointer to tcp client.
[in]	path	Path to the file.
[in]	user	NULL-terminated user name
[in]	pass	NULL-terminated password

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

It must be noted that access to metadata, supported by some file systems, is limited by the use of function fopen. Alternate Data Streams (WIndows NTFS) and Resource Forks (OS X HFS) may or may not be supported, depending on the C standard library used in the application.

KSI_FsClient_setExtender()

int KSI_FsClient_setExtender	(	KSI_NetworkClient *	client,
		const char *	path,
		const char *	user,
		const char *	pass
	)

Setter for the file system client extender parameters.

Parameters

[in]	client	Pointer to tcp client.
[in]	path	Path to the file.
[in]	user	NULL-terminated user name
[in]	pass	NULL-terminated password

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

It must be noted that access to metadata, supported by some file systems, is limited by the use of function fopen. Alternate Data Streams (WIndows NTFS) and Resource Forks (OS X HFS) may or may not be supported, depending on the C standard library used in the application.

KSI_FsClient_setPublicationUrl()

int KSI_FsClient_setPublicationUrl	(	KSI_NetworkClient *	client,
		const char *	path
	)

Setter for the publications file URL. The value will be copied and thus can be freed after successful call.

Parameters

[in]	client	Pointer to the http client.
[in]	path	Null-terminated file path.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

It must be noted that access to metadata, supported by some file systems, is limited by the use of function fopen. Alternate Data Streams (WIndows NTFS) and Resource Forks (OS X HFS) may or may not be supported, depending on the C standard library used in the application.