VirtualDir.hpp File Reference

Provide the Virtual Directory Callbacks structure. More...

#include <upnp.hpp>

Include dependency graph for VirtualDir.hpp:

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

Go to the source code of this file.

Classes
struct	VirtualDirCallbacks
struct	virtual_Dir_List
	Virtual directory list. More...

Typedefs
typedef struct virtual_Dir_List	virtualDirList
	Virtual directory list.

Detailed Description

Provide the Virtual Directory Callbacks structure.

Definition in file VirtualDir.hpp.

---

Class Documentation

VirtualDirCallbacks

struct VirtualDirCallbacks

The VirtualDirCallbacks structure contains the pointers to file-related callback functions a device application can register to virtualize URLs.

Definition at line 17 of file VirtualDir.hpp.

Collaboration diagram for VirtualDirCallbacks:

Class Members
VDCallback_GetInfo	get_info	Called by the web server to query information on a file. The callback should return 0 on success or -1 on an error.
VDCallback_Open	open	Called by the web server to open a file. The callback should return a valid handle if the file can be opened. Otherwise, it should return NULL to signify an error.
VDCallback_Read	read	Called by the web server to perform a sequential read from an open file. The callback should copy buflen bytes from the file into the buffer. Returns An integer representing one of the following: 0: The file contains no more data (EOF). > 0: A successful read of the number of bytes in the return code. < 0: An error occurred reading the file.
VDCallback_Write	write	Called by the web server to perform a sequential write to an open file. The callback should write buflen bytes into the file from the buffer. It should return the actual number of bytes written, which might be less than buflen in the case of a write error.
VDCallback_Seek	seek	Called by the web server to move the file pointer, or offset, into an open file. The origin parameter determines where to start moving the file pointer. A value of SEEK_CUR moves the file pointer relative to where it is. The offset parameter can be either positive (move forward) or negative (move backward). SEEK_END moves relative to the end of the file. A positive offset extends the file. A negative offset moves backward in the file. Finally, SEEK_SET moves to an absolute position in the file. In this case, offset must be positive. The callback should return 0 on a successful seek or a non-zero value on an error.
VDCallback_Close	close	Called by the web server to close a file opened via the open callback. It should return 0 on success, or a non-zero value on an error.

virtual_Dir_List

struct virtual_Dir_List

Virtual directory list.

Definition at line 67 of file VirtualDir.hpp.

Collaboration diagram for virtual_Dir_List:

Class Members
struct virtual_Dir_List *	next	Member of virtual directory list
const void *	cookie	Member of virtual directory list
char	dirName[NAME_SIZE]	Member of virtual directory list