#ifndef SMBCLIENT_H_INCLUDED
#define SMBCLIENT_H_INCLUDED
+#undef DEPRECATED_SMBC_INTERFACE
+#if ! defined(__LIBSMBCLIENT_INTERNAL__) && defined(__GNUC__)
+# define DEPRECATED_SMBC_INTERFACE __attribute__ ((deprecated))
+#else
+# define DEPRECATED_SMBC_INTERFACE
+#endif
+
#ifdef __cplusplus
extern "C" {
#endif
/* Make sure we have the following includes for now ... */
#include <sys/types.h>
#include <sys/stat.h>
+#include <sys/statvfs.h>
#include <fcntl.h>
#include <utime.h>
/*
* Valid values for the option "open_share_mode", when calling
- * smbc_option_set()
+ * smbc_setOptionOpenShareMode()
*/
typedef enum smbc_share_mode
{
} smbc_share_mode;
+/**
+ * Values for option SMB Encryption Level, as set and retrieved with
+ * smbc_setOptionSmbEncryptionLevel() and smbc_getOptionSmbEncryptionLevel()
+ */
+typedef enum smbc_smb_encrypt_level
+{
+ SMBC_ENCRYPTLEVEL_NONE = 0,
+ SMBC_ENCRYPTLEVEL_REQUEST = 1,
+ SMBC_ENCRYPTLEVEL_REQUIRE = 2
+} smbc_smb_encrypt_level;
+
+
+/**
+ * Capabilities set in the f_flag field of struct statvfs, from
+ * smbc_statvfs(). These may be OR-ed together to reflect a full set of
+ * available capabilities.
+ */
+typedef enum smbc_vfs_feature
+{
+ /* Defined by POSIX or in Linux include files (low-order bits) */
+ SMBC_VFS_FEATURE_RDONLY = (1 << 0),
+
+ /* Specific to libsmbclient (high-order bits) */
+ SMBC_VFS_FEATURE_DFS = (1 << 28),
+ SMBC_VFS_FEATURE_CASE_INSENSITIVE = (1 << 29),
+ SMBC_VFS_FEATURE_NO_UNIXCIFS = (1 << 30)
+} smbc_vfs_feature;
+
+typedef int smbc_bool;
+
+
#ifndef ENOATTR
# define ENOATTR ENOENT /* No such attribute */
#endif
/*
+ * Flags for SMBCCTX->flags
+ *
* NEW CODE SHOULD NOT DIRECTLY MANIPULATE THE CONTEXT STRUCTURE.
- * For these options, use smbc_option_set() and smbc_option_get().
+ * Instead, use:
+ * smbc_setOptionUseKerberos()
+ * smbc_getOptionUseKerberos()
+ * smbc_setOptionFallbackAfterKerberos()
+ * smbc_getOptionFallbackAFterKerberos()
+ * smbc_setOptionNoAutoAnonymousLogin()
+ * smbc_getOptionNoAutoAnonymousLogin()
*/
-
-/* Flags for SMBCCTX->flags */
# define SMB_CTX_FLAG_USE_KERBEROS (1 << 0)
# define SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS (1 << 1)
# define SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON (1 << 2)
* Type for the the authentication function called by the library to
* obtain authentication credentals
*
+ * For kerberos support the function should just be called without
+ * prompting the user for credentials. Which means a simple 'return'
+ * should work. Take a look at examples/libsmbclient/get_auth_data_fn.h
+ * and examples/libsmbclient/testbrowse.c.
+ *
* @param srv Server being authenticated to
*
* @param shr Share being authenticated to
* Type for the the authentication function called by the library to
* obtain authentication credentals
*
+ * For kerberos support the function should just be called without
+ * prompting the user for credentials. Which means a simple 'return'
+ * should work. Take a look at examples/libsmbclient/get_auth_data_fn.h
+ * and examples/libsmbclient/testbrowse.c.
+ *
* @param c Pointer to the smb context
*
* @param srv Server being authenticated to
* @return 0 when found and removed. 1 on failure.
*
*/
-typedef int (*smbc_purge_cached_srv_fn) (SMBCCTX * c);
+typedef int (*smbc_purge_cached_fn) (SMBCCTX * c);
+
+/*****************************************
+ * Getters and setters for CONFIGURATION *
+ *****************************************/
+
/** Get the debug level */
-int smbc_getDebug(SMBCCTX *c);
+int
+smbc_getDebug(SMBCCTX *c);
/** Set the debug level */
-void smbc_setDebug(SMBCCTX *c, int debug);
+void
+smbc_setDebug(SMBCCTX *c, int debug);
/** Get the netbios name used for making connections */
-char * smbc_getNetbiosName(SMBCCTX *c);
+char *
+smbc_getNetbiosName(SMBCCTX *c);
/** Set the netbios name used for making connections */
-void smbc_setNetbiosName(SMBCCTX *c, char * netbios_name);
+void
+smbc_setNetbiosName(SMBCCTX *c, char * netbios_name);
/** Get the workgroup used for making connections */
-char * smbc_getWorkgroup(SMBCCTX *c);
+char *
+smbc_getWorkgroup(SMBCCTX *c);
/** Set the workgroup used for making connections */
void smbc_setWorkgroup(SMBCCTX *c, char * workgroup);
/** Get the username used for making connections */
-char * smbc_getUser(SMBCCTX *c);
+char *
+smbc_getUser(SMBCCTX *c);
/** Set the username used for making connections */
-void smbc_setUser(SMBCCTX *c, char * user);
+void
+smbc_setUser(SMBCCTX *c, char * user);
/**
* Get the timeout used for waiting on connections and response data
* (in milliseconds)
*/
-int smbc_getTimeout(SMBCCTX *c);
+int
+smbc_getTimeout(SMBCCTX *c);
/**
* Set the timeout used for waiting on connections and response data
* (in milliseconds)
*/
-void smbc_setTimeout(SMBCCTX *c, int timeout);
+void
+smbc_setTimeout(SMBCCTX *c, int timeout);
+
+
+
+/***********************************
+ * Getters and setters for OPTIONS *
+ ***********************************/
+
+/** Get whether to log to standard error instead of standard output */
+smbc_bool
+smbc_getOptionDebugToStderr(SMBCCTX *c);
+
+/** Set whether to log to standard error instead of standard output */
+void
+smbc_setOptionDebugToStderr(SMBCCTX *c, smbc_bool b);
+
+/**
+ * Get whether to use new-style time attribute names, e.g. WRITE_TIME rather
+ * than the old-style names such as M_TIME. This allows also setting/getting
+ * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
+ * was supposed to be CHANGE_TIME but was confused and sometimes referred to
+ * CREATE_TIME.)
+ */
+smbc_bool
+smbc_getOptionFullTimeNames(SMBCCTX *c);
+
+/**
+ * Set whether to use new-style time attribute names, e.g. WRITE_TIME rather
+ * than the old-style names such as M_TIME. This allows also setting/getting
+ * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
+ * was supposed to be CHANGE_TIME but was confused and sometimes referred to
+ * CREATE_TIME.)
+ */
+void
+smbc_setOptionFullTimeNames(SMBCCTX *c, smbc_bool b);
+
+/**
+ * Get the share mode to use for files opened with SMBC_open_ctx(). The
+ * default is SMBC_SHAREMODE_DENY_NONE.
+ */
+smbc_share_mode
+smbc_getOptionOpenShareMode(SMBCCTX *c);
+
+/**
+ * Set the share mode to use for files opened with SMBC_open_ctx(). The
+ * default is SMBC_SHAREMODE_DENY_NONE.
+ */
+void
+smbc_setOptionOpenShareMode(SMBCCTX *c, smbc_share_mode share_mode);
+
+/** Retrieve a previously saved user data handle */
+void *
+smbc_getOptionUserData(SMBCCTX *c);
+
+/** Save a user data handle */
+void
+smbc_setOptionUserData(SMBCCTX *c, void *user_data);
+
+/** Get the encoded value for encryption level. */
+smbc_smb_encrypt_level
+smbc_getOptionSmbEncryptionLevel(SMBCCTX *c);
+
+/** Set the encoded value for encryption level. */
+void
+smbc_setOptionSmbEncryptionLevel(SMBCCTX *c, smbc_smb_encrypt_level level);
+
+/**
+ * Get whether to treat file names as case-sensitive if we can't determine
+ * when connecting to the remote share whether the file system is case
+ * sensitive. This defaults to FALSE since it's most likely that if we can't
+ * retrieve the file system attributes, it's a very old file system that does
+ * not support case sensitivity.
+ */
+smbc_bool
+smbc_getOptionCaseSensitive(SMBCCTX *c);
+
+/**
+ * Set whether to treat file names as case-sensitive if we can't determine
+ * when connecting to the remote share whether the file system is case
+ * sensitive. This defaults to FALSE since it's most likely that if we can't
+ * retrieve the file system attributes, it's a very old file system that does
+ * not support case sensitivity.
+ */
+void
+smbc_setOptionCaseSensitive(SMBCCTX *c, smbc_bool b);
+
+
+/**
+ * Get from how many local master browsers should the list of workgroups be
+ * retrieved. It can take up to 12 minutes or longer after a server becomes a
+ * local master browser, for it to have the entire browse list (the list of
+ * workgroups/domains) from an entire network. Since a client never knows
+ * which local master browser will be found first, the one which is found
+ * first and used to retrieve a browse list may have an incomplete or empty
+ * browse list. By requesting the browse list from multiple local master
+ * browsers, a more complete list can be generated. For small networks (few
+ * workgroups), it is recommended that this value be set to 0, causing the
+ * browse lists from all found local master browsers to be retrieved and
+ * merged. For networks with many workgroups, a suitable value for this
+ * variable is probably somewhere around 3. (Default: 3).
+ */
+int
+smbc_getOptionBrowseMaxLmbCount(SMBCCTX *c);
+
+/**
+ * Set from how many local master browsers should the list of workgroups be
+ * retrieved. It can take up to 12 minutes or longer after a server becomes a
+ * local master browser, for it to have the entire browse list (the list of
+ * workgroups/domains) from an entire network. Since a client never knows
+ * which local master browser will be found first, the one which is found
+ * first and used to retrieve a browse list may have an incomplete or empty
+ * browse list. By requesting the browse list from multiple local master
+ * browsers, a more complete list can be generated. For small networks (few
+ * workgroups), it is recommended that this value be set to 0, causing the
+ * browse lists from all found local master browsers to be retrieved and
+ * merged. For networks with many workgroups, a suitable value for this
+ * variable is probably somewhere around 3. (Default: 3).
+ */
+void
+smbc_setOptionBrowseMaxLmbCount(SMBCCTX *c, int count);
+
+/**
+ * Get whether to url-encode readdir entries.
+ *
+ * There is a difference in the desired return strings from
+ * smbc_readdir() depending upon whether the filenames are to
+ * be displayed to the user, or whether they are to be
+ * appended to the path name passed to smbc_opendir() to call
+ * a further smbc_ function (e.g. open the file with
+ * smbc_open()). In the former case, the filename should be
+ * in "human readable" form. In the latter case, the smbc_
+ * functions expect a URL which must be url-encoded. Those
+ * functions decode the URL. If, for example, smbc_readdir()
+ * returned a file name of "abc%20def.txt", passing a path
+ * with this file name attached to smbc_open() would cause
+ * smbc_open to attempt to open the file "abc def.txt" since
+ * the %20 is decoded into a space.
+ *
+ * Set this option to True if the names returned by
+ * smbc_readdir() should be url-encoded such that they can be
+ * passed back to another smbc_ call. Set it to False if the
+ * names returned by smbc_readdir() are to be presented to the
+ * user.
+ *
+ * For backwards compatibility, this option defaults to False.
+ */
+smbc_bool
+smbc_getOptionUrlEncodeReaddirEntries(SMBCCTX *c);
+
+/**
+ * Set whether to url-encode readdir entries.
+ *
+ * There is a difference in the desired return strings from
+ * smbc_readdir() depending upon whether the filenames are to
+ * be displayed to the user, or whether they are to be
+ * appended to the path name passed to smbc_opendir() to call
+ * a further smbc_ function (e.g. open the file with
+ * smbc_open()). In the former case, the filename should be
+ * in "human readable" form. In the latter case, the smbc_
+ * functions expect a URL which must be url-encoded. Those
+ * functions decode the URL. If, for example, smbc_readdir()
+ * returned a file name of "abc%20def.txt", passing a path
+ * with this file name attached to smbc_open() would cause
+ * smbc_open to attempt to open the file "abc def.txt" since
+ * the %20 is decoded into a space.
+ *
+ * Set this option to True if the names returned by
+ * smbc_readdir() should be url-encoded such that they can be
+ * passed back to another smbc_ call. Set it to False if the
+ * names returned by smbc_readdir() are to be presented to the
+ * user.
+ *
+ * For backwards compatibility, this option defaults to False.
+ */
+void
+smbc_setOptionUrlEncodeReaddirEntries(SMBCCTX *c, smbc_bool b);
+
+/**
+ * Get whether to use the same connection for all shares on a server.
+ *
+ * Some Windows versions appear to have a limit to the number
+ * of concurrent SESSIONs and/or TREE CONNECTions. In
+ * one-shot programs (i.e. the program runs and then quickly
+ * ends, thereby shutting down all connections), it is
+ * probably reasonable to establish a new connection for each
+ * share. In long-running applications, the limitation can be
+ * avoided by using only a single connection to each server,
+ * and issuing a new TREE CONNECT when the share is accessed.
+ */
+smbc_bool
+smbc_getOptionOneSharePerServer(SMBCCTX *c);
+
+/**
+ * Set whether to use the same connection for all shares on a server.
+ *
+ * Some Windows versions appear to have a limit to the number
+ * of concurrent SESSIONs and/or TREE CONNECTions. In
+ * one-shot programs (i.e. the program runs and then quickly
+ * ends, thereby shutting down all connections), it is
+ * probably reasonable to establish a new connection for each
+ * share. In long-running applications, the limitation can be
+ * avoided by using only a single connection to each server,
+ * and issuing a new TREE CONNECT when the share is accessed.
+ */
+void
+smbc_setOptionOneSharePerServer(SMBCCTX *c, smbc_bool b);
+
+/** Get whether to enable use of kerberos */
+smbc_bool
+smbc_getOptionUseKerberos(SMBCCTX *c);
+
+/** Set whether to enable use of kerberos */
+void
+smbc_setOptionUseKerberos(SMBCCTX *c, smbc_bool b);
+
+/** Get whether to fallback after kerberos */
+smbc_bool
+smbc_getOptionFallbackAfterKerberos(SMBCCTX *c);
+
+/** Set whether to fallback after kerberos */
+void
+smbc_setOptionFallbackAfterKerberos(SMBCCTX *c, smbc_bool b);
+
+/** Get whether to automatically select anonymous login */
+smbc_bool
+smbc_getOptionNoAutoAnonymousLogin(SMBCCTX *c);
+
+/** Set whether to automatically select anonymous login */
+void
+smbc_setOptionNoAutoAnonymousLogin(SMBCCTX *c, smbc_bool b);
+
+
+
+/*************************************
+ * Getters and setters for FUNCTIONS *
+ *************************************/
/** Get the function for obtaining authentication data */
smbc_get_auth_data_fn smbc_getFunctionAuthData(SMBCCTX *c);
/** Set the function for obtaining authentication data */
-void smbc_setFunctionAuthData(SMBCCTX *c, smbc_get_auth_data_fn f);
+void smbc_setFunctionAuthData(SMBCCTX *c, smbc_get_auth_data_fn fn);
+
+/** Get the new-style authentication function which includes the context. */
+smbc_get_auth_data_with_context_fn
+smbc_getFunctionAuthDataWithContext(SMBCCTX *c);
+
+/** Set the new-style authentication function which includes the context. */
+void
+smbc_setFunctionAuthDataWithContext(SMBCCTX *c,
+ smbc_get_auth_data_with_context_fn fn);
/** Get the function for checking if a server is still good */
smbc_check_server_fn smbc_getFunctionCheckServer(SMBCCTX *c);
/** Set the function for checking if a server is still good */
-void smbc_setFunctionCheckServer(SMBCCTX *c, smbc_check_server_fn f);
+void smbc_setFunctionCheckServer(SMBCCTX *c, smbc_check_server_fn fn);
/** Get the function for removing a server if unused */
smbc_remove_unused_server_fn smbc_getFunctionRemoveUnusedServer(SMBCCTX *c);
/** Set the function for removing a server if unused */
void smbc_setFunctionRemoveUnusedServer(SMBCCTX *c,
- smbc_remove_unused_server_fn f);
+ smbc_remove_unused_server_fn fn);
/** Get the function for adding a cached server */
smbc_add_cached_srv_fn smbc_getFunctionAddCachedServer(SMBCCTX *c);
/** Set the function for adding a cached server */
-void smbc_setFunctionAddCachedServer(SMBCCTX *c, smbc_add_cached_srv_fn f);
+void smbc_setFunctionAddCachedServer(SMBCCTX *c, smbc_add_cached_srv_fn fn);
/** Get the function for server cache lookup */
smbc_get_cached_srv_fn smbc_getFunctionGetCachedServer(SMBCCTX *c);
/** Set the function for server cache lookup */
-void smbc_setFunctionGetCachedServer(SMBCCTX *c, smbc_get_cached_srv_fn f);
+void smbc_setFunctionGetCachedServer(SMBCCTX *c, smbc_get_cached_srv_fn fn);
/** Get the function for server cache removal */
smbc_remove_cached_srv_fn smbc_getFunctionRemoveCachedServer(SMBCCTX *c);
/** Set the function for server cache removal */
void smbc_setFunctionRemoveCachedServer(SMBCCTX *c,
- smbc_remove_cached_srv_fn f);
+ smbc_remove_cached_srv_fn fn);
/**
* Get the function for server cache purging. This function tries to
* remove all cached servers (e.g. on disconnect)
*/
-smbc_purge_cached_srv_fn smbc_getFunctionPurgeCachedServers(SMBCCTX *c);
+smbc_purge_cached_fn smbc_getFunctionPurgeCachedServers(SMBCCTX *c);
/**
* Set the function for server cache purging. This function tries to
* remove all cached servers (e.g. on disconnect)
*/
void smbc_setFunctionPurgeCachedServers(SMBCCTX *c,
- smbc_purge_cached_srv_fn f);
+ smbc_purge_cached_fn fn);
/** Get the function to store private data of the server cache */
struct smbc_server_cache * smbc_getServerCacheData(SMBCCTX *c);
void smbc_setServerCacheData(SMBCCTX *c, struct smbc_server_cache * cache);
-/**
- * Callable functions for files.
- */
+
+/*****************************************************************
+ * Callable functions for files. *
+ * Each callable has a function signature typedef, a declaration *
+ * for the getter, and a declaration for the setter. *
+ *****************************************************************/
typedef SMBCFILE * (*smbc_open_fn)(SMBCCTX *c,
const char *fname,
int flags,
mode_t mode);
smbc_open_fn smbc_getFunctionOpen(SMBCCTX *c);
-void smbc_setFunctionOpen(SMBCCTX *c, smbc_open_fn f);
+void smbc_setFunctionOpen(SMBCCTX *c, smbc_open_fn fn);
typedef SMBCFILE * (*smbc_creat_fn)(SMBCCTX *c,
const char *path,
void *buf,
size_t count);
smbc_read_fn smbc_getFunctionRead(SMBCCTX *c);
-void smbc_setFunctionRead(SMBCCTX *c, smbc_read_fn f);
+void smbc_setFunctionRead(SMBCCTX *c, smbc_read_fn fn);
typedef ssize_t (*smbc_write_fn)(SMBCCTX *c,
SMBCFILE *file,
- void *buf,
+ const void *buf,
size_t count);
smbc_write_fn smbc_getFunctionWrite(SMBCCTX *c);
-void smbc_setFunctionWrite(SMBCCTX *c, smbc_write_fn f);
+void smbc_setFunctionWrite(SMBCCTX *c, smbc_write_fn fn);
typedef int (*smbc_unlink_fn)(SMBCCTX *c,
const char *fname);
smbc_unlink_fn smbc_getFunctionUnlink(SMBCCTX *c);
-void smbc_setFunctionUnlink(SMBCCTX *c, smbc_unlink_fn f);
+void smbc_setFunctionUnlink(SMBCCTX *c, smbc_unlink_fn fn);
typedef int (*smbc_rename_fn)(SMBCCTX *ocontext,
const char *oname,
SMBCCTX *ncontext,
const char *nname);
smbc_rename_fn smbc_getFunctionRename(SMBCCTX *c);
-void smbc_setFunctionRename(SMBCCTX *c, smbc_rename_fn f);
+void smbc_setFunctionRename(SMBCCTX *c, smbc_rename_fn fn);
typedef off_t (*smbc_lseek_fn)(SMBCCTX *c,
SMBCFILE * file,
off_t offset,
int whence);
smbc_lseek_fn smbc_getFunctionLseek(SMBCCTX *c);
-void smbc_setFunctionLseek(SMBCCTX *c, smbc_lseek_fn f);
+void smbc_setFunctionLseek(SMBCCTX *c, smbc_lseek_fn fn);
typedef int (*smbc_stat_fn)(SMBCCTX *c,
const char *fname,
struct stat *st);
smbc_stat_fn smbc_getFunctionStat(SMBCCTX *c);
-void smbc_setFunctionStat(SMBCCTX *c, smbc_stat_fn f);
+void smbc_setFunctionStat(SMBCCTX *c, smbc_stat_fn fn);
typedef int (*smbc_fstat_fn)(SMBCCTX *c,
SMBCFILE *file,
struct stat *st);
smbc_fstat_fn smbc_getFunctionFstat(SMBCCTX *c);
-void smbc_setFunctionFstat(SMBCCTX *c, smbc_fstat_fn f);
+void smbc_setFunctionFstat(SMBCCTX *c, smbc_fstat_fn fn);
+
+typedef int (*smbc_statvfs_fn)(SMBCCTX *c,
+ char *path,
+ struct statvfs *st);
+smbc_statvfs_fn smbc_getFunctionStatVFS(SMBCCTX *c);
+void smbc_setFunctionStatVFS(SMBCCTX *c, smbc_statvfs_fn fn);
+
+typedef int (*smbc_fstatvfs_fn)(SMBCCTX *c,
+ SMBCFILE *file,
+ struct statvfs *st);
+smbc_fstatvfs_fn smbc_getFunctionFstatVFS(SMBCCTX *c);
+void smbc_setFunctionFstatVFS(SMBCCTX *c, smbc_fstatvfs_fn fn);
typedef int (*smbc_ftruncate_fn)(SMBCCTX *c,
SMBCFILE *f,
off_t size);
smbc_ftruncate_fn smbc_getFunctionFtruncate(SMBCCTX *c);
-void smbc_setFunctionFtruncate(SMBCCTX *c, smbc_ftruncate_fn f);
+void smbc_setFunctionFtruncate(SMBCCTX *c, smbc_ftruncate_fn fn);
typedef int (*smbc_close_fn)(SMBCCTX *c,
SMBCFILE *file);
smbc_close_fn smbc_getFunctionClose(SMBCCTX *c);
-void smbc_setFunctionClose(SMBCCTX *c, smbc_close_fn f);
+void smbc_setFunctionClose(SMBCCTX *c, smbc_close_fn fn);
-/**
- * Callable functions for directories.
- */
+
+/*****************************************************************
+ * Callable functions for directories. *
+ * Each callable has a function signature typedef, a declaration *
+ * for the getter, and a declaration for the setter. *
+ *****************************************************************/
typedef SMBCFILE * (*smbc_opendir_fn)(SMBCCTX *c,
const char *fname);
smbc_opendir_fn smbc_getFunctionOpendir(SMBCCTX *c);
-void smbc_setFunctionOpendir(SMBCCTX *c, smbc_opendir_fn f);
+void smbc_setFunctionOpendir(SMBCCTX *c, smbc_opendir_fn fn);
typedef int (*smbc_closedir_fn)(SMBCCTX *c,
SMBCFILE *dir);
smbc_closedir_fn smbc_getFunctionClosedir(SMBCCTX *c);
-void smbc_setFunctionClosedir(SMBCCTX *c, smbc_closedir_fn f);
+void smbc_setFunctionClosedir(SMBCCTX *c, smbc_closedir_fn fn);
typedef struct smbc_dirent * (*smbc_readdir_fn)(SMBCCTX *c,
SMBCFILE *dir);
smbc_readdir_fn smbc_getFunctionReaddir(SMBCCTX *c);
-void smbc_setFunctionReaddir(SMBCCTX *c, smbc_readdir_fn f);
+void smbc_setFunctionReaddir(SMBCCTX *c, smbc_readdir_fn fn);
typedef int (*smbc_getdents_fn)(SMBCCTX *c,
SMBCFILE *dir,
struct smbc_dirent *dirp,
int count);
smbc_getdents_fn smbc_getFunctionGetdents(SMBCCTX *c);
-void smbc_setFunctionGetdents(SMBCCTX *c, smbc_getdents_fn f);
+void smbc_setFunctionGetdents(SMBCCTX *c, smbc_getdents_fn fn);
typedef int (*smbc_mkdir_fn)(SMBCCTX *c,
const char *fname,
mode_t mode);
smbc_mkdir_fn smbc_getFunctionMkdir(SMBCCTX *c);
-void smbc_setFunctionMkdir(SMBCCTX *c, smbc_mkdir_fn f);
+void smbc_setFunctionMkdir(SMBCCTX *c, smbc_mkdir_fn fn);
typedef int (*smbc_rmdir_fn)(SMBCCTX *c,
const char *fname);
smbc_rmdir_fn smbc_getFunctionRmdir(SMBCCTX *c);
-void smbc_setFunctionRmdir(SMBCCTX *c, smbc_rmdir_fn f);
+void smbc_setFunctionRmdir(SMBCCTX *c, smbc_rmdir_fn fn);
typedef off_t (*smbc_telldir_fn)(SMBCCTX *c,
SMBCFILE *dir);
smbc_telldir_fn smbc_getFunctionTelldir(SMBCCTX *c);
-void smbc_setFunctionTelldir(SMBCCTX *c, smbc_telldir_fn f);
+void smbc_setFunctionTelldir(SMBCCTX *c, smbc_telldir_fn fn);
typedef int (*smbc_lseekdir_fn)(SMBCCTX *c,
SMBCFILE *dir,
off_t offset);
smbc_lseekdir_fn smbc_getFunctionLseekdir(SMBCCTX *c);
-void smbc_setFunctionLseekdir(SMBCCTX *c, smbc_lseekdir_fn f);
+void smbc_setFunctionLseekdir(SMBCCTX *c, smbc_lseekdir_fn fn);
typedef int (*smbc_fstatdir_fn)(SMBCCTX *c,
SMBCFILE *dir,
struct stat *st);
smbc_fstatdir_fn smbc_getFunctionFstatdir(SMBCCTX *c);
-void smbc_setFunctionFstatdir(SMBCCTX *c, smbc_fstatdir_fn f);
+void smbc_setFunctionFstatdir(SMBCCTX *c, smbc_fstatdir_fn fn);
-/**
- * Callable functions applicable to both files and directories.
- */
+
+/*****************************************************************
+ * Callable functions applicable to both files and directories. *
+ * Each callable has a function signature typedef, a declaration *
+ * for the getter, and a declaration for the setter. *
+ *****************************************************************/
typedef int (*smbc_chmod_fn)(SMBCCTX *c,
const char *fname,
mode_t mode);
smbc_chmod_fn smbc_getFunctionChmod(SMBCCTX *c);
-void smbc_setFunctionChmod(SMBCCTX *c, smbc_chmod_fn f);
+void smbc_setFunctionChmod(SMBCCTX *c, smbc_chmod_fn fn);
typedef int (*smbc_utimes_fn)(SMBCCTX *c,
const char *fname,
struct timeval *tbuf);
smbc_utimes_fn smbc_getFunctionUtimes(SMBCCTX *c);
-void smbc_setFunctionUtimes(SMBCCTX *c, smbc_utimes_fn f);
+void smbc_setFunctionUtimes(SMBCCTX *c, smbc_utimes_fn fn);
typedef int (*smbc_setxattr_fn)(SMBCCTX *context,
const char *fname,
size_t size,
int flags);
smbc_setxattr_fn smbc_getFunctionSetxattr(SMBCCTX *c);
-void smbc_setFunctionSetxattr(SMBCCTX *c, smbc_setxattr_fn f);
+void smbc_setFunctionSetxattr(SMBCCTX *c, smbc_setxattr_fn fn);
typedef int (*smbc_getxattr_fn)(SMBCCTX *context,
const char *fname,
const void *value,
size_t size);
smbc_getxattr_fn smbc_getFunctionGetxattr(SMBCCTX *c);
-void smbc_setFunctionGetxattr(SMBCCTX *c, smbc_getxattr_fn f);
+void smbc_setFunctionGetxattr(SMBCCTX *c, smbc_getxattr_fn fn);
typedef int (*smbc_removexattr_fn)(SMBCCTX *context,
const char *fname,
const char *name);
smbc_removexattr_fn smbc_getFunctionRemovexattr(SMBCCTX *c);
-void smbc_setFunctionRemovexattr(SMBCCTX *c, smbc_removexattr_fn f);
+void smbc_setFunctionRemovexattr(SMBCCTX *c, smbc_removexattr_fn fn);
typedef int (*smbc_listxattr_fn)(SMBCCTX *context,
const char *fname,
char *list,
size_t size);
smbc_listxattr_fn smbc_getFunctionListxattr(SMBCCTX *c);
-void smbc_setFunctionListxattr(SMBCCTX *c, smbc_listxattr_fn f);
+void smbc_setFunctionListxattr(SMBCCTX *c, smbc_listxattr_fn fn);
-/**
- * Callable functions related to printing
- */
+
+/*****************************************************************
+ * Callable functions for printing. *
+ * Each callable has a function signature typedef, a declaration *
+ * for the getter, and a declaration for the setter. *
+ *****************************************************************/
typedef int (*smbc_print_file_fn)(SMBCCTX *c_file,
const char *fname,
SMBCCTX *c_print,
const char *printq);
smbc_print_file_fn smbc_getFunctionPrintFile(SMBCCTX *c);
-void smbc_setFunctionPrintFile(SMBCCTX *c, smbc_print_file_fn f);
+void smbc_setFunctionPrintFile(SMBCCTX *c, smbc_print_file_fn fn);
typedef SMBCFILE * (*smbc_open_print_job_fn)(SMBCCTX *c,
const char *fname);
smbc_open_print_job_fn smbc_getFunctionOpenPrintJob(SMBCCTX *c);
void smbc_setFunctionOpenPrintJob(SMBCCTX *c,
- smbc_open_print_job_fn f);
+ smbc_open_print_job_fn fn);
typedef int (*smbc_list_print_jobs_fn)(SMBCCTX *c,
const char *fname,
smbc_list_print_job_fn fn);
smbc_list_print_jobs_fn smbc_getFunctionListPrintJobs(SMBCCTX *c);
void smbc_setFunctionListPrintJobs(SMBCCTX *c,
- smbc_list_print_jobs_fn f);
+ smbc_list_print_jobs_fn fn);
typedef int (*smbc_unlink_print_job_fn)(SMBCCTX *c,
const char *fname,
int id);
smbc_unlink_print_job_fn smbc_getFunctionUnlinkPrintJob(SMBCCTX *c);
void smbc_setFunctionUnlinkPrintJob(SMBCCTX *c,
- smbc_unlink_print_job_fn f);
+ smbc_unlink_print_job_fn fn);
/**@ingroup misc
/**@ingroup misc
- * Each time the context structure is changed, we have binary backward
- * compatibility issues. Instead of modifying the public portions of the
- * context structure to add new options, instead, we put them in the internal
- * portion of the context structure and provide a set function for these new
- * options.
- *
- * @param context A pointer to a SMBCCTX obtained from smbc_new_context()
- *
- * @param option_name
- * The name of the option for which the value is to be set
- *
- * @param option_value
- * The new value of the option being set
*
+ * @deprecated. Use smbc_setOption*() functions instead.
*/
void
smbc_option_set(SMBCCTX *context,
char *option_name,
... /* option_value */);
+
/*
- * Retrieve the current value of an option
- *
- * @param context A pointer to a SMBCCTX obtained from smbc_new_context()
- *
- * @param option_name
- * The name of the option for which the value is to be
- * retrieved
- *
- * @return The value of the specified option.
+ * @deprecated. Use smbc_getOption*() functions instead.
*/
void *
smbc_option_get(SMBCCTX *context,
* @see smbc_open(), smbc_read()
*
*/
-ssize_t smbc_write(int fd, void *buf, size_t bufsize);
+ssize_t smbc_write(int fd, const void *buf, size_t bufsize);
/**@ingroup file
/**@ingroup attribute
- * Truncate a file given a file descriptor
+ * Get file system information for a specified path.
*
- * @param fd Open file handle from smbc_open() or smbc_creat()
+ * @param url The smb url to get information for
*
- * @param size size to truncate the file to
+ * @param st pointer to a buffer that will be filled with
+ * standard Unix struct statvfs information.
*
* @return EBADF filedes is bad.
* - EACCES Permission denied.
* or smbc_init not called.
* - ENOMEM Out of memory
*
- * @see , Unix ftruncate()
+ * @see Unix fstatvfs()
*
*/
-int smbc_ftruncate(int fd, off_t size);
-
+int
+smbc_statvfs(char *url,
+ struct statvfs *st);
-/**@ingroup attribue
- * Change the ownership of a file or directory.
- *
- * @param url The smb url of the file or directory to change
- * ownership of.
+/**@ingroup attribute
+ * Get file system information via an file descriptor.
+ *
+ * @param fd Open file handle from smbc_open(), smbc_creat(),
+ * or smbc_opendir()
*
- * @param owner I have no idea?
+ * @param st pointer to a buffer that will be filled with
+ * standard Unix struct statvfs information.
+ *
+ * @return EBADF filedes is bad.
+ * - EACCES Permission denied.
+ * - EBADF fd is not a valid file descriptor
+ * - EINVAL Problems occurred in the underlying routines
+ * or smbc_init not called.
+ * - ENOMEM Out of memory
*
- * @param group I have not idea?
+ * @see Unix fstatvfs()
*
- * @return 0 on success, < 0 on error with errno set:
- * - EPERM The effective UID does not match the owner
- * of the file, and is not zero; or the owner or group
- * were specified incorrectly.
- * - ENOENT The file does not exist.
- * - ENOMEM Insufficient was available.
- * - ENOENT file or directory does not exist
+ */
+int
+smbc_fstatvfs(int fd,
+ struct statvfs *st);
+
+
+/**@ingroup attribute
+ * Truncate a file given a file descriptor
+ *
+ * @param fd Open file handle from smbc_open() or smbc_creat()
*
- * @todo Are we actually going to be able to implement this function
+ * @param size size to truncate the file to
+ *
+ * @return EBADF filedes is bad.
+ * - EACCES Permission denied.
+ * - EBADF fd is not a valid file descriptor
+ * - EINVAL Problems occurred in the underlying routines
+ * or smbc_init not called.
+ * - ENOMEM Out of memory
*
- * @todo How do we abstract owner and group uid and gid?
+ * @see , Unix ftruncate()
*
*/
-int smbc_chown(const char *url, uid_t owner, gid_t group);
+int smbc_ftruncate(int fd, off_t size);
/**@ingroup attribute
}
#endif
+/**@ingroup misc
+ * Set the users credentials globally so they can be used for DFS
+ * referrals. Probably best to use this function in the smbc_get_auth_data_fn
+ * callback.
+ *
+ * @param workgroup Workgroup of the user.
+ *
+ * @param user Username of user.
+ *
+ * @param password Password of user.
+ *
+ * @param use_kerberos Whether to use Kerberos
+ *
+ * @param signing_state One of these strings (all equivalents on same line):
+ * "off", "no", "false"
+ * "on", "yes", "true", "auto"
+ * "force", "required", "forced"
+ */
+
+void
+smbc_set_credentials(const char *workgroup,
+ const char *user,
+ const char *password,
+ smbc_bool use_kerberos,
+ const char *signing_state);
+
+/*
+ * Wrapper around smbc_set_credentials.
+ * Used to set correct credentials that will
+ * be used to connect to DFS target share
+ * in libsmbclient
+ */
+
+void
+smbc_set_credentials_with_fallback(SMBCCTX *ctx,
+ const char *workgroup,
+ const char *user,
+ const char *password);
+
+
+/**
+ * @ingroup threads
+ *
+ * Initialize for threads using the Posix Threads (pthread)
+ * implementation. This is a built-in implementation, avoiding the need to
+ * implement the component functions of the thread interface. If this function
+ * is used, it is not necessary to call smbc_thread_impl().
+ *
+ * @return {void}
+ */
+void
+smbc_thread_posix(void);
+
+/**
+ * @ingroup threads
+ *
+ * Initialize for an arbitrary thread implementation. The caller should
+ * provide, as parameters, pointers to functions to implement the requisite
+ * low-level thread functionality. A function must be provided for each
+ * parameter; none may be null.
+ *
+ * If the thread implementation is POSIX Threads (pthreads), then the much
+ * simpler smbc_thread_pthread() function may be used instead of this one.
+ *
+ * @param create_mutex
+ * Create a mutex. This function should expect three parameters: lockname,
+ * pplock, and location. It should create a unique mutex for each unique
+ * lockname it is provided, and return the mutex identifier in *pplock. The
+ * location parameter can be used for debugging, as it contains the
+ * compiler-provided __location__ of the call.
+ *
+ * @param destroy_mutex
+ * Destroy a mutex. This function should expect two parameters: plock and
+ * location. It should destroy the mutex associated with the identifier
+ * plock. The location parameter can be used for debugging, as it contains
+ * the compiler-provided __location__ of the call.
+ *
+ * @param lock_mutex
+ * Lock a mutex. This function should expect three parameters: plock,
+ * lock_type, and location. The mutex aassociated with identifier plock
+ * should be locked if lock_type is 1, and unlocked if lock_type is 2. The
+ * location parameter can be used for debugging, as it contains the
+ * compiler-provided __location__ of the call.
+ *
+ * @param create_tls
+ * Create thread local storage. This function should expect three
+ * parameters: keyname, ppkey, and location. It should allocate an
+ * implementation-specific amount of memory and assign the pointer to that
+ * allocated memory to *ppkey. The location parameter can be used for
+ * debugging, as it contains the compiler-provided __location__ of the
+ * call. This function should return 0 upon success, non-zero upon failure.
+ *
+ * @param destroy_tls
+ * Destroy thread local storage. This function should expect two parameters:
+ * ppkey and location. The ppkey parameter points to a variable containing a
+ * thread local storage key previously provided by the create_tls
+ * function. The location parameter can be used for debugging, as it
+ * contains the compiler-provided __location__ of the call.
+ *
+ * @param set_tls
+ * Set a thread local storage variable's value. This function should expect
+ * three parameters: pkey, pval, and location. The pkey parameter is a
+ * thread local storage key previously provided by the create_tls
+ * function. The (void *) pval parameter contains the value to be placed in
+ * the thread local storage variable identified by pkey. The location
+ * parameter can be used for debugging, as it contains the compiler-provided
+ * __location__ of the call. This function should return 0 upon success;
+ * non-zero otherwise.
+ *
+ * @param get_tls
+ * Retrieve a thread local storage variable's value. This function should
+ * expect two parameters: pkey and location. The pkey parameter is a thread
+ * local storage key previously provided by the create_tls function, and
+ * which has previously been used in a call to the set_tls function to
+ * initialize a thread local storage variable. The location parameter can be
+ * used for debugging, as it contains the compiler-provided __location__ of
+ * the call. This function should return the (void *) value stored in the
+ * variable identified by pkey.
+ *
+ * @return {void}
+ */
+void
+smbc_thread_impl(
+ /* Mutex functions. */
+ int (*create_mutex)(const char *lockname,
+ void **pplock,
+ const char *location),
+ void (*destroy_mutex)(void *plock,
+ const char *location),
+ int (*lock_mutex)(void *plock,
+ int lock_type,
+ const char *location),
+
+ /* Thread local storage. */
+ int (*create_tls)(const char *keyname,
+ void **ppkey,
+ const char *location),
+ void (*destroy_tls)(void **ppkey,
+ const char *location),
+ int (*set_tls)(void *pkey,
+ const void *pval,
+ const char *location),
+ void *(*get_tls)(void *pkey,
+ const char *location)
+ );
+
+
/**
* @ingroup structure
* directly visible to applications. This makes it much easier to maintain
* ABI compatibility.
*/
-struct _SMBCCTX {
- struct
- {
- /**
- * debug level
- *
- * Use smbc_getDebug() and smbc_setDebug()
- */
- int debug;
+struct _SMBCCTX
+{
+ /**
+ * debug level
+ *
+ * DEPRECATED:
+ * Use smbc_getDebug() and smbc_setDebug()
+ */
+ int debug DEPRECATED_SMBC_INTERFACE;
- /**
- * netbios name used for making connections
- *
- * Use smbc_getNetbiosName() and smbc_setNetbiosName()
- */
- char * netbios_name;
+ /**
+ * netbios name used for making connections
+ *
+ * DEPRECATED:
+ * Use smbc_getNetbiosName() and smbc_setNetbiosName()
+ */
+ char * netbios_name DEPRECATED_SMBC_INTERFACE;
- /**
- * workgroup name used for making connections
- *
- * Use smbc_getWorkgroup() and smbc_setWorkgroup()
- */
- char * workgroup;
+ /**
+ * workgroup name used for making connections
+ *
+ * DEPRECATED:
+ * Use smbc_getWorkgroup() and smbc_setWorkgroup()
+ */
+ char * workgroup DEPRECATED_SMBC_INTERFACE;
- /**
- * username used for making connections
- *
- * Use smbc_getUser() and smbc_setUser()
- */
- char * user;
+ /**
+ * username used for making connections
+ *
+ * DEPRECATED:
+ * Use smbc_getUser() and smbc_setUser()
+ */
+ char * user DEPRECATED_SMBC_INTERFACE;
- /**
- * timeout used for waiting on connections / response data (in
- * milliseconds)
- *
- * Use smbc_getTimeout() and smbc_setTimeout()
- */
- int timeout;
- } config;
+ /**
+ * timeout used for waiting on connections / response data (in
+ * milliseconds)
+ *
+ * DEPRECATED:
+ * Use smbc_getTimeout() and smbc_setTimeout()
+ */
+ int timeout DEPRECATED_SMBC_INTERFACE;
/**
* callable functions for files:
* For usage and return values see the SMBC_* functions
*
+ * DEPRECATED:
+ *
* Use smbc_getFunction*() and smbc_setFunction*(), e.g.
* smbc_getFunctionOpen(), smbc_setFunctionUnlink(), etc.
*/
- struct
- {
- smbc_open_fn open_fn;
- smbc_creat_fn creat_fn;
- smbc_read_fn read_fn;
- smbc_write_fn write_fn;
- smbc_unlink_fn unlink_fn;
- smbc_rename_fn rename_fn;
- smbc_lseek_fn lseek_fn;
- smbc_stat_fn stat_fn;
- smbc_fstat_fn fstat_fn;
+ smbc_open_fn open DEPRECATED_SMBC_INTERFACE;
+ smbc_creat_fn creat DEPRECATED_SMBC_INTERFACE;
+ smbc_read_fn read DEPRECATED_SMBC_INTERFACE;
+ smbc_write_fn write DEPRECATED_SMBC_INTERFACE;
+ smbc_unlink_fn unlink DEPRECATED_SMBC_INTERFACE;
+ smbc_rename_fn rename DEPRECATED_SMBC_INTERFACE;
+ smbc_lseek_fn lseek DEPRECATED_SMBC_INTERFACE;
+ smbc_stat_fn stat DEPRECATED_SMBC_INTERFACE;
+ smbc_fstat_fn fstat DEPRECATED_SMBC_INTERFACE;
#if 0 /* internal */
- smbc_ftruncate_fn ftruncate_fn;
+ smbc_ftruncate_fn ftruncate_fn;
#endif
- smbc_close_fn close_fn;
- smbc_opendir_fn opendir_fn;
- smbc_closedir_fn closedir_fn;
- smbc_readdir_fn readdir_fn;
- smbc_getdents_fn getdents_fn;
- smbc_mkdir_fn mkdir_fn;
- smbc_rmdir_fn rmdir_fn;
- smbc_telldir_fn telldir_fn;
- smbc_lseekdir_fn lseekdir_fn;
- smbc_fstatdir_fn fstatdir_fn;
- smbc_chmod_fn chmod_fn;
- smbc_utimes_fn utimes_fn;
- smbc_setxattr_fn setxattr_fn;
- smbc_getxattr_fn getxattr_fn;
- smbc_removexattr_fn removexattr_fn;
- smbc_listxattr_fn listxattr_fn;
- } posix_emu;
+ smbc_close_fn close_fn DEPRECATED_SMBC_INTERFACE;
+ smbc_opendir_fn opendir DEPRECATED_SMBC_INTERFACE;
+ smbc_closedir_fn closedir DEPRECATED_SMBC_INTERFACE;
+ smbc_readdir_fn readdir DEPRECATED_SMBC_INTERFACE;
+ smbc_getdents_fn getdents DEPRECATED_SMBC_INTERFACE;
+ smbc_mkdir_fn mkdir DEPRECATED_SMBC_INTERFACE;
+ smbc_rmdir_fn rmdir DEPRECATED_SMBC_INTERFACE;
+ smbc_telldir_fn telldir DEPRECATED_SMBC_INTERFACE;
+ smbc_lseekdir_fn lseekdir DEPRECATED_SMBC_INTERFACE;
+ smbc_fstatdir_fn fstatdir DEPRECATED_SMBC_INTERFACE;
+ smbc_chmod_fn chmod DEPRECATED_SMBC_INTERFACE;
+ smbc_utimes_fn utimes DEPRECATED_SMBC_INTERFACE;
+ smbc_setxattr_fn setxattr DEPRECATED_SMBC_INTERFACE;
+ smbc_getxattr_fn getxattr DEPRECATED_SMBC_INTERFACE;
+ smbc_removexattr_fn removexattr DEPRECATED_SMBC_INTERFACE;
+ smbc_listxattr_fn listxattr DEPRECATED_SMBC_INTERFACE;
/* Printing-related functions */
- struct
- {
- smbc_print_file_fn print_file_fn;
- smbc_open_print_job_fn open_print_job_fn;
- smbc_list_print_jobs_fn list_print_jobs_fn;
- smbc_unlink_print_job_fn unlink_print_job_fn;
- } printing;
+ smbc_print_file_fn print_file DEPRECATED_SMBC_INTERFACE;
+ smbc_open_print_job_fn open_print_job DEPRECATED_SMBC_INTERFACE;
+ smbc_list_print_jobs_fn list_print_jobs DEPRECATED_SMBC_INTERFACE;
+ smbc_unlink_print_job_fn unlink_print_job DEPRECATED_SMBC_INTERFACE;
/*
** Callbacks
- * These callbacks _always_ have to be initialized because they will
- * not be checked at dereference for increased speed.
+ *
+ * DEPRECATED:
+ *
+ * See the comment above each field, for the getter and setter
+ * functions that should now be used.
*/
- struct
+ struct _smbc_callbacks
{
/**
* authentication function callback: called upon auth requests
*
+ * DEPRECATED:
* Use smbc_getFunctionAuthData(), smbc_setFunctionAuthData()
*/
- smbc_get_auth_data_fn get_auth_data_fn;
+ smbc_get_auth_data_fn auth_fn DEPRECATED_SMBC_INTERFACE;
/**
* check if a server is still good
*
+ * DEPRECATED:
* Use smbc_getFunctionCheckServer(),
* smbc_setFunctionCheckServer()
*/
- smbc_check_server_fn check_server_fn;
+ smbc_check_server_fn check_server_fn DEPRECATED_SMBC_INTERFACE;
/**
* remove a server if unused
*
+ * DEPRECATED:
* Use smbc_getFunctionRemoveUnusedServer(),
* smbc_setFunctionCheckServer()
*/
- smbc_remove_unused_server_fn remove_unused_server_fn;
- } server;
+ smbc_remove_unused_server_fn remove_unused_server_fn DEPRECATED_SMBC_INTERFACE;
- struct
- {
/** Cache subsystem
*
* For an example cache system see
/**
* server cache addition
*
+ * DEPRECATED:
* Use smbc_getFunctionAddCachedServer(),
* smbc_setFunctionAddCachedServer()
*/
- smbc_add_cached_srv_fn add_cached_server_fn;
+ smbc_add_cached_srv_fn add_cached_srv_fn DEPRECATED_SMBC_INTERFACE;
/**
* server cache lookup
*
+ * DEPRECATED:
* Use smbc_getFunctionGetCachedServer(),
* smbc_setFunctionGetCachedServer()
*/
- smbc_get_cached_srv_fn get_cached_server_fn;
+ smbc_get_cached_srv_fn get_cached_srv_fn DEPRECATED_SMBC_INTERFACE;
/**
* server cache removal
*
+ * DEPRECATED:
* Use smbc_getFunctionRemoveCachedServer(),
* smbc_setFunctionRemoveCachedServer()
*/
- smbc_remove_cached_srv_fn remove_cached_server_fn;
+ smbc_remove_cached_srv_fn remove_cached_srv_fn DEPRECATED_SMBC_INTERFACE;
/**
* server cache purging, try to remove all cached servers
* (disconnect)
*
+ * DEPRECATED:
* Use smbc_getFunctionPurgeCachedServers(),
* smbc_setFunctionPurgeCachedServers()
*/
- smbc_purge_cached_srv_fn purge_cached_servers_fn;
+ smbc_purge_cached_fn purge_cached_fn DEPRECATED_SMBC_INTERFACE;
+ } callbacks;
- /**
- * Space to store private data of the server cache.
- *
- * Use smbc_getServerCacheData(), smbc_setServerCacheData()
- */
- struct smbc_server_cache * server_cache_data;
- } cache;
+ /**
+ * Space where the private data of the server cache used to be
+ *
+ * DEPRECATED:
+ * Use smbc_getServerCacheData(), smbc_setServerCacheData()
+ */
+ void * reserved DEPRECATED_SMBC_INTERFACE;
/*
* Very old configuration options.
*
- * Use smbc_option_set() and smbc_option_get() instead.
+ * DEPRECATED:
+ * Use one of the following functions instead:
+ * smbc_setOptionUseKerberos()
+ * smbc_getOptionUseKerberos()
+ * smbc_setOptionFallbackAfterKerberos()
+ * smbc_getOptionFallbackAfterKerberos()
+ * smbc_setOptionNoAutoAnonymousLogin()
+ * smbc_getOptionNoAutoAnonymousLogin()
*/
- struct
- {
- int bits;
- } flags;
+ int flags DEPRECATED_SMBC_INTERFACE;
- /** user options selections that apply to this session
- *
- * NEW CODE SHOULD NOT DIRECTLY MANIPULATE THE CONTEXT STRUCTURE.
+ /**
+ * user options selections that apply to this session
*
- * NEW OPTIONS ARE NOT ADDED HERE!
+ * NEW OPTIONS ARE NOT ADDED HERE!
*
- * We must maintain ABI backward compatibility. We now use
- * smbc_option_set() and smbc_option_get() for all newly added
- * options.
+ * DEPRECATED:
+ * To set and retrieve options, use the smbc_setOption*() and
+ * smbc_getOption*() functions.
*/
struct _smbc_options {
-
- /*
- * From how many local master browsers should the list of
- * workgroups be retrieved? It can take up to 12 minutes or
- * longer after a server becomes a local master browser, for
- * it to have the entire browse list (the list of
- * workgroups/domains) from an entire network. Since a client
- * never knows which local master browser will be found first,
- * the one which is found first and used to retrieve a browse
- * list may have an incomplete or empty browse list. By
- * requesting the browse list from multiple local master
- * browsers, a more complete list can be generated. For small
- * networks (few workgroups), it is recommended that this
- * value be set to 0, causing the browse lists from all found
- * local master browsers to be retrieved and merged. For
- * networks with many workgroups, a suitable value for this
- * variable is probably somewhere around 3. (Default: 3).
- */
- int browse_max_lmb_count;
-
- /*
- * There is a difference in the desired return strings from
- * smbc_readdir() depending upon whether the filenames are to
- * be displayed to the user, or whether they are to be
- * appended to the path name passed to smbc_opendir() to call
- * a further smbc_ function (e.g. open the file with
- * smbc_open()). In the former case, the filename should be
- * in "human readable" form. In the latter case, the smbc_
- * functions expect a URL which must be url-encoded. Those
- * functions decode the URL. If, for example, smbc_readdir()
- * returned a file name of "abc%20def.txt", passing a path
- * with this file name attached to smbc_open() would cause
- * smbc_open to attempt to open the file "abc def.txt" since
- * the %20 is decoded into a space.
- *
- * Set this option to True if the names returned by
- * smbc_readdir() should be url-encoded such that they can be
- * passed back to another smbc_ call. Set it to False if the
- * names returned by smbc_readdir() are to be presented to the
- * user.
- *
- * For backwards compatibility, this option defaults to False.
- */
- int urlencode_readdir_entries;
-
- /*
- * Some Windows versions appear to have a limit to the number
- * of concurrent SESSIONs and/or TREE CONNECTions. In
- * one-shot programs (i.e. the program runs and then quickly
- * ends, thereby shutting down all connections), it is
- * probably reasonable to establish a new connection for each
- * share. In long-running applications, the limitation can be
- * avoided by using only a single connection to each server,
- * and issuing a new TREE CONNECT when the share is accessed.
- */
- int one_share_per_server;
- } options;
+ int browse_max_lmb_count DEPRECATED_SMBC_INTERFACE;
+ int urlencode_readdir_entries DEPRECATED_SMBC_INTERFACE;
+ int one_share_per_server DEPRECATED_SMBC_INTERFACE;
+ } options DEPRECATED_SMBC_INTERFACE;
/** INTERNAL DATA
* do _NOT_ touch this from your program !
git.samba.org / ira / wip.git / blobdiff