list		API documentation		The XML C parser and toolkit of Gnome	nanohttp

minimal FTP implementation allowing to fetch resources like external subset.

Table of Contents

#define INVALID_SOCKET

#define SOCKET

Function type: ftpDataCallback
void	ftpDataCallback			(void * userData, 
					 const char * data, 
					 int len)

Function type: ftpListCallback
void	ftpListCallback			(void * userData, 
					 const char * filename, 
					 const char * attrib, 
					 const char * owner, 
					 const char * group, 
					 unsigned long size, 
					 int links, 
					 int year, 
					 const char * month, 
					 int day, 
					 int hour, 
					 int minute)

int	xmlNanoFTPCheckResponse		(void * ctx)

void	xmlNanoFTPCleanup		(void)

int	xmlNanoFTPClose			(void * ctx)

int	xmlNanoFTPCloseConnection	(void * ctx)

int	xmlNanoFTPConnect		(void * ctx)

void *	xmlNanoFTPConnectTo		(const char * server, 
					 int port)

int	xmlNanoFTPCwd			(void * ctx, 
					 const char * directory)

int	xmlNanoFTPDele			(void * ctx, 
					 const char * file)

void	xmlNanoFTPFreeCtxt		(void * ctx)

int	xmlNanoFTPGet			(void * ctx, 
					 ftpDataCallback callback, 
					 void * userData, 
					 const char * filename)

SOCKET	xmlNanoFTPGetConnection		(void * ctx)

int	xmlNanoFTPGetResponse		(void * ctx)

SOCKET	xmlNanoFTPGetSocket		(void * ctx, 
					 const char * filename)

void	xmlNanoFTPInit			(void)

int	xmlNanoFTPList			(void * ctx, 
					 ftpListCallback callback, 
					 void * userData, 
					 const char * filename)

void *	xmlNanoFTPNewCtxt		(const char * URL)

void *	xmlNanoFTPOpen			(const char * URL)

void	xmlNanoFTPProxy			(const char * host, 
					 int port, 
					 const char * user, 
					 const char * passwd, 
					 int type)

int	xmlNanoFTPQuit			(void * ctx)

int	xmlNanoFTPRead			(void * ctx, 
					 void * dest, 
					 int len)

void	xmlNanoFTPScanProxy		(const char * URL)

int	xmlNanoFTPUpdateURL		(void * ctx, 
					 const char * URL)

Description

Macro: INVALID_SOCKET

#define INVALID_SOCKET

macro used to provide portability of code to windows sockets the value to be used when the socket is not valid

Macro: SOCKET

#define SOCKET

macro used to provide portability of code to windows sockets

Function type: ftpDataCallback

Function type: ftpDataCallback
void	ftpDataCallback			(void * userData, 
					 const char * data, 
					 int len)

A callback for the xmlNanoFTPGet command.

Function type: ftpListCallback

Function type: ftpListCallback
void	ftpListCallback			(void * userData, 
					 const char * filename, 
					 const char * attrib, 
					 const char * owner, 
					 const char * group, 
					 unsigned long size, 
					 int links, 
					 int year, 
					 const char * month, 
					 int day, 
					 int hour, 
					 int minute)

A callback for the xmlNanoFTPList command. Note that only one of year and day:minute are specified.

Function: xmlNanoFTPCheckResponse

int	xmlNanoFTPCheckResponse		(void * ctx)

Check if there is a response from the FTP server after a command.

Function: xmlNanoFTPCleanup

void	xmlNanoFTPCleanup		(void)

Cleanup the FTP protocol layer. This cleanup proxy informations.

Function: xmlNanoFTPClose

int	xmlNanoFTPClose			(void * ctx)

Close the connection and both control and transport

Function: xmlNanoFTPCloseConnection

int	xmlNanoFTPCloseConnection	(void * ctx)

Close the data connection from the server

Function: xmlNanoFTPConnect

int	xmlNanoFTPConnect		(void * ctx)

Tries to open a control connection

Function: xmlNanoFTPConnectTo

void *	xmlNanoFTPConnectTo		(const char * server, 
					 int port)

Tries to open a control connection to the given server/port

Function: xmlNanoFTPCwd

int	xmlNanoFTPCwd			(void * ctx, 
					 const char * directory)

Tries to change the remote directory

Function: xmlNanoFTPDele

int	xmlNanoFTPDele			(void * ctx, 
					 const char * file)

Tries to delete an item (file or directory) from server

Function: xmlNanoFTPFreeCtxt

void	xmlNanoFTPFreeCtxt		(void * ctx)

Frees the context after closing the connection.

Function: xmlNanoFTPGet

int	xmlNanoFTPGet			(void * ctx, 
					 ftpDataCallback callback, 
					 void * userData, 
					 const char * filename)

Fetch the given file from the server. All data are passed back in the callbacks. The last callback has a size of 0 block.

Function: xmlNanoFTPGetConnection

SOCKET	xmlNanoFTPGetConnection		(void * ctx)

Try to open a data connection to the server. Currently only passive mode is supported.

Function: xmlNanoFTPGetResponse

int	xmlNanoFTPGetResponse		(void * ctx)

Get the response from the FTP server after a command.

Function: xmlNanoFTPGetSocket

SOCKET	xmlNanoFTPGetSocket		(void * ctx, 
					 const char * filename)

Initiate fetch of the given file from the server.

Function: xmlNanoFTPInit

void	xmlNanoFTPInit			(void)

Initialize the FTP protocol layer. Currently it just checks for proxy informations, and get the hostname

Function: xmlNanoFTPList

int	xmlNanoFTPList			(void * ctx, 
					 ftpListCallback callback, 
					 void * userData, 
					 const char * filename)

Do a listing on the server. All files info are passed back in the callbacks.

Function: xmlNanoFTPNewCtxt

void *	xmlNanoFTPNewCtxt		(const char * URL)

Allocate and initialize a new FTP context.

Function: xmlNanoFTPOpen

void *	xmlNanoFTPOpen			(const char * URL)

Start to fetch the given ftp:// resource

Function: xmlNanoFTPProxy

void	xmlNanoFTPProxy			(const char * host, 
					 int port, 
					 const char * user, 
					 const char * passwd, 
					 int type)

Setup the FTP proxy informations. This can also be done by using ftp_proxy ftp_proxy_user and ftp_proxy_password environment variables.

Function: xmlNanoFTPQuit

int	xmlNanoFTPQuit			(void * ctx)

Send a QUIT command to the server

Function: xmlNanoFTPRead

int	xmlNanoFTPRead			(void * ctx, 
					 void * dest, 
					 int len)

This function tries to read @len bytes from the existing FTP connection and saves them in @dest. This is a blocking call.

Function: xmlNanoFTPScanProxy

void	xmlNanoFTPScanProxy		(const char * URL)

(Re)Initialize the FTP Proxy context by parsing the URL and finding the protocol host port it indicates. Should be like ftp://myproxy/ or ftp://myproxy:3128/ A NULL URL cleans up proxy informations.

Function: xmlNanoFTPUpdateURL

int	xmlNanoFTPUpdateURL		(void * ctx, 
					 const char * URL)

Update an FTP context by parsing the URL and finding new path it indicates. If there is an error in the protocol, hostname, port or other information, the error is raised. It indicates a new connection has to be established.

Daniel Veillard