C# Class FoundationDB.Client.Fdb.Options

Global settings for the FoundationDB binding

Show file Open project: BedeGaming/foundationdb-dotnet-client

Public Properties

Property	Type	Description
NativeLibPath	string
TracePath	string

Public Methods

Method	Description
DisableNativeLibraryPreloading ( ) : void	Disable preloading of the native C API library. The CLR will handle the binding of the library. This must be called before the start of the network thread, otherwise it won't have any effects.
EnableNativeLibraryPreloading ( ) : void	Enable automatic preloading of the native C API library. The operating system will handle the binding of the library This must be called before the start of the network thread, otherwise it won't have any effects.
SetNativeLibPath ( string path ) : void	Preload the native C API library from a specifc path (relative of absolute) where the fdb_c.dll library is located This must be called before the start of the network thread, otherwise it won't have any effects. You can specify the path to a library with a custom file name by making sure that path ends with ".dll". If not, then "fdb_c.dll" will be appended to the path.
SetTLSCertificate ( Slice bytes ) : void	Sets the path to the root certificate and public key for TLS connections This must be called before the start of the network thread, otherwise it won't have any effects.
SetTLSCertificate ( string path ) : void	Sets the path to the root certificate and public key for TLS connections This must be called before the start of the network thread, otherwise it won't have any effects.
SetTLSPlugin ( string name ) : void	Set the file path or linker-resolved name of the custom TLS plugin to load.
SetTLSPrivateKey ( Slice bytes ) : void	Sets the path to the private key for TLS connections This must be called before the start of the network thread, otherwise it won't have any effects.
SetTLSPrivateKey ( string path ) : void	Sets the path to the private key for TLS connections This must be called before the start of the network thread, otherwise it won't have any effects.
SetTlsVerificationPattern ( Slice pattern ) : void	Sets the pattern with wich to verify certificates of TLS peers This must be called before the start of the network thread, otherwise it won't have any effects.
SetTracePath ( string outputDirectory ) : void	Sets the custom path where the logs will be stored This must be called before the start of the network thread, otherwise it won't have any effects.
UseTLS ( Slice certificateBytes, Slice privateKeyBytes, Slice verificationPattern = default(Slice), string plugin = null ) : void	Use TLS to secure the connections to the cluster
UseTLS ( string certificatePath, string privateKeyPath, Slice verificationPattern = default(Slice), string plugin = null ) : void	Use TLS to secure the connections to the cluster

Method Details

DisableNativeLibraryPreloading() public static method

Disable preloading of the native C API library. The CLR will handle the binding of the library.

This *must* be called before the start of the network thread, otherwise it won't have any effects.

public static DisableNativeLibraryPreloading ( ) : void
return	void

EnableNativeLibraryPreloading() public static method

Enable automatic preloading of the native C API library. The operating system will handle the binding of the library

This *must* be called before the start of the network thread, otherwise it won't have any effects.

public static EnableNativeLibraryPreloading ( ) : void
return	void

SetNativeLibPath() public static method

Preload the native C API library from a specifc path (relative of absolute) where the fdb_c.dll library is located

This *must* be called before the start of the network thread, otherwise it won't have any effects. You can specify the path to a library with a custom file name by making sure that path ends with ".dll". If not, then "fdb_c.dll" will be appended to the path.

public static SetNativeLibPath ( string path ) : void
path	string
return	void

SetTLSCertificate() public static method

Sets the path to the root certificate and public key for TLS connections

This *must* be called before the start of the network thread, otherwise it won't have any effects.

public static SetTLSCertificate ( Slice bytes ) : void
bytes	Slice
return	void

SetTLSCertificate() public static method

Sets the path to the root certificate and public key for TLS connections

This *must* be called before the start of the network thread, otherwise it won't have any effects.

public static SetTLSCertificate ( string path ) : void
path	string
return	void

SetTLSPlugin() public static method

Set the file path or linker-resolved name of the custom TLS plugin to load.

public static SetTLSPlugin ( string name ) : void
name	string
return	void

SetTLSPrivateKey() public static method

Sets the path to the private key for TLS connections

This must be called before the start of the network thread, otherwise it won't have any effects.

public static SetTLSPrivateKey ( Slice bytes ) : void
bytes	Slice
return	void

SetTLSPrivateKey() public static method

Sets the path to the private key for TLS connections

This must be called before the start of the network thread, otherwise it won't have any effects.

public static SetTLSPrivateKey ( string path ) : void
path	string
return	void

SetTlsVerificationPattern() public static method

Sets the pattern with wich to verify certificates of TLS peers

This must be called before the start of the network thread, otherwise it won't have any effects.

public static SetTlsVerificationPattern ( Slice pattern ) : void
pattern	Slice
return	void

SetTracePath() public static method

Sets the custom path where the logs will be stored

This *must* be called before the start of the network thread, otherwise it won't have any effects.

public static SetTracePath ( string outputDirectory ) : void
outputDirectory	string
return	void

UseTLS() public static method

Use TLS to secure the connections to the cluster

public static UseTLS ( Slice certificateBytes, Slice privateKeyBytes, Slice verificationPattern = default(Slice), string plugin = null ) : void
certificateBytes	Slice	Content of the root certificate and public key
privateKeyBytes	Slice	Content of the private key
verificationPattern	Slice	Verification with which to verify certificates of TLS peers
plugin	string	Optional file path or linker-resolved name of the custom TLS plugin to load
return	void

UseTLS() public static method

Use TLS to secure the connections to the cluster

public static UseTLS ( string certificatePath, string privateKeyPath, Slice verificationPattern = default(Slice), string plugin = null ) : void
certificatePath	string	Path to the root certificate and public key
privateKeyPath	string	Path to the private key
verificationPattern	Slice	Verification with which to verify certificates of TLS peers
plugin	string	Optional file path or linker-resolved name of the custom TLS plugin to load
return	void

Property Details

NativeLibPath public static property

Custom path from where to load the native C API library. If null, let the CLR find the dll. If String.Empty let Win32's LoadLibrary find the correct dll, else use the specified path to load the library

public static string NativeLibPath
return	string

TracePath public static property

Default path to the network thread tracing file

public static string TracePath
return	string