---

file_browsing.hh File Reference

File browsing service include file. More...

Go to the source code of this file.

Compounds
struct	Directory_entries
struct	Directory_entry
struct	List_response
struct	List_structured_response
struct	Size_response
struct	Time_response
Functions
int	ns__DATAConnectedList (char *in_URL, int verbose, struct List_response *resp)
	Lists the content of a directory.
int	ns__DATAConnectedListStructured (char *in_URL, struct List_structured_response *resp)
	Lists and parses the content of a directory.
int	ns__DATAStopCache (void *dump, char **response)
	Destroys the data structure that was used to cache the GridFTP connections.
int	ns__DATAConnectedModTime (char *in_URL, struct Time_response *resp)
	Returns the modification time of a directory entry.
int	ns__DATAConnectedSize (char *in_URL, struct Size_response *resp)
	Returns the size of a file.
int	ns__isAlive (int dump, int *response)
	Test method.
int	ns__getServiceDescription (void *dump, char **description)
	Returns a string description of the service.

---

Detailed Description

File browsing service include file.

GridLab File browsing service include file used for generating server and client stubs with gsoap Author : Andrei Hutanu, ZIB

Definition in file file_browsing.hh.

---

Function Documentation

int ns__DATAConnectedList (  char *    in_URL, int    verbose, struct List_response *    resp )

Lists the content of a directory. This is the main function of the browsing service. When called for the first time, this method initiates a cached connection to the GridFTP server if possible. That connection will be used for all the following list operations until the StopCache method is called. Also, the service will not cache more than a fixed number of connections at one time. Parameters: in_URL  the URL of the directory to be listed verbose  A boolean parameter. When set to 1 will result in detailed listing of the given directory (ls -l). When set to 0, the method will return just a list of entries in that directory. resp  the return parameter Returns: the unparsed directory listing and an error message See also: ns__DATAStopCache

int ns__DATAConnectedListStructured (  char *    in_URL, struct List_structured_response *    resp )

Lists and parses the content of a directory. This method provides a structured response to a verbose directory listing. The text returned by the server is parsed and separated in directory entries. A cached connection will be used or initiated for this operation. Parameters: in_URL  the URL of the directory to be listed resp  the return parameter Returns: the structured directory listing and an error message See also: ns__DATAConnectedList , ns__DATAStopCache

int ns__DATAConnectedModTime (  char *    in_URL, struct Time_response *    resp )

Returns the modification time of a directory entry. Returns the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds. A cached connection will be used or initiated for this operation. Parameters: in_URL  the URL of the directory entry resp  the return parameter Returns: the modification time and an error message See also: ns__DATAConnectedList , ns__DATAStopCache

int ns__DATAConnectedSize (  char *    in_URL, struct Size_response *    resp )

Returns the size of a file. Returns the file size in bytes. A cached connection will be used or initiated for this operation. Parameters: in_URL  the URL of the directory entry resp  the return parameter Returns: the file size and an error message See also: ns__DATAConnectedList , ns__DATAStopCache

int ns__DATAStopCache (  void *    dump, char **    response )

Destroys the data structure that was used to cache the GridFTP connections. This method deletes the client handle, cached for the user connecting to the service. This removes all cached connections for that user. The method should be used when the user does not need to make any other listing operations to free the memory. Parameters: dump  not used response  the return parameter Returns: error code (numeric) followed by human-readable text

int ns__getServiceDescription (  void *    dump, char **    description )

Returns a string description of the service. Parameters: dump  unused description  return parameter

int ns__isAlive (  int    dump, int *    response )

Test method. Returns 1 (used to see if the service is running) Parameters: dump  unused response  return parameter

---