UpnpVirtualDirCallbacks Struct Reference

#include <upnp.h>

Data Fields
int(*	get_info )(IN const char *filename, OUT struct File_Info *info)
UpnpWebFileHandle(*	open )(IN const char *filename, OUT struct File_Info *info, IN enum UpnpOpenFileMode Mode)
int(*	read )(IN UpnpWebFileHandle fileHnd, OUT char *buf, IN size_t buflen)
int(*	write )(IN UpnpWebFileHandle fileHnd, IN char *buf, IN size_t buflen)
int(*	seek )(IN UpnpWebFileHandle fileHnd, IN off_t offset, IN int origin)
int(*	close )(IN UpnpWebFileHandle fileHnd)

---

Detailed Description

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

Definition at line 939 of file upnp.h.

---

Field Documentation

int(* UpnpVirtualDirCallbacks::close)(IN UpnpWebFileHandle fileHnd)

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.

Referenced by register_web_callbacks().

int(* UpnpVirtualDirCallbacks::get_info)(IN const char *filename,OUT struct File_Info *info)

Called by the web server to query information on a file. The callback should return 0 on success or -1 on an error.

Referenced by register_web_callbacks().

UpnpWebFileHandle(* UpnpVirtualDirCallbacks::open)(IN const char *filename,OUT struct File_Info *info,IN enum UpnpOpenFileMode Mode)

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.

Referenced by register_web_callbacks().

int(* UpnpVirtualDirCallbacks::read)(IN UpnpWebFileHandle fileHnd,OUT char *buf,IN size_t buflen)

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:

[int] An integer representing one of the following: {itemize} { 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. {itemzie}

Referenced by register_web_callbacks().

int(* UpnpVirtualDirCallbacks::seek)(IN UpnpWebFileHandle fileHnd,IN off_t offset,IN int origin)

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.

Referenced by register_web_callbacks().

int(* UpnpVirtualDirCallbacks::write)(IN UpnpWebFileHandle fileHnd,IN char *buf,IN size_t buflen)

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.

Referenced by register_web_callbacks().

---

The documentation for this struct was generated from the following file:

• upnp.h