NFSClient Class

Properties   Methods   Events   Config Settings   Errors  

This class is used to create a Network File System (NFS) client based on NFS version 4.0.

Class Name

IPWorksNFS_NFSClient

Procedural Interface

 ipworksnfs_nfsclient_open();
 ipworksnfs_nfsclient_close($res);
 ipworksnfs_nfsclient_register_callback($res, $id, $function);
 ipworksnfs_nfsclient_get_last_error($res);
 ipworksnfs_nfsclient_get_last_error_code($res);
 ipworksnfs_nfsclient_set($res, $id, $index, $value);
 ipworksnfs_nfsclient_get($res, $id, $index);
 ipworksnfs_nfsclient_do_abort($res);
 ipworksnfs_nfsclient_do_append($res);
 ipworksnfs_nfsclient_do_changeremotepath($res, $remotepath);
 ipworksnfs_nfsclient_do_checkfileexists($res);
 ipworksnfs_nfsclient_do_close($res, $path, $filename);
 ipworksnfs_nfsclient_do_config($res, $configurationstring);
 ipworksnfs_nfsclient_do_connect($res);
 ipworksnfs_nfsclient_do_createfile($res, $filename);
 ipworksnfs_nfsclient_do_createlink($res, $linkname, $linktarget, $linktype);
 ipworksnfs_nfsclient_do_deletefile($res, $filename);
 ipworksnfs_nfsclient_do_disconnect($res);
 ipworksnfs_nfsclient_do_doevents($res);
 ipworksnfs_nfsclient_do_download($res);
 ipworksnfs_nfsclient_do_listdirectory($res);
 ipworksnfs_nfsclient_do_makedirectory($res, $newdir);
 ipworksnfs_nfsclient_do_open($res, $path, $filename, $shareaccess, $sharedeny);
 ipworksnfs_nfsclient_do_queryfileattributes($res);
 ipworksnfs_nfsclient_do_read($res, $path, $filename, $startbyte, $count, $buffer);
 ipworksnfs_nfsclient_do_readlink($res, $linkname);
 ipworksnfs_nfsclient_do_removedirectory($res, $dirname);
 ipworksnfs_nfsclient_do_renamefile($res, $newname);
 ipworksnfs_nfsclient_do_renew($res);
 ipworksnfs_nfsclient_do_reset($res);
 ipworksnfs_nfsclient_do_updatefileattributes($res);
 ipworksnfs_nfsclient_do_upload($res);
 ipworksnfs_nfsclient_do_write($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

This class provides a simple way to create a Network File System (NFS) client, enabling seamless connection and access to files hosted on an NFS server.

Getting Started

To begin, the RemoteHost and RemotePort properties should first be set to the host and port of the NFS server. By default, the RemotePort property is set to 2049. The LocalHost and LocalPort properties may also be set to specify the name of the local host or user-assigned IP interface through which connections are initiated. Note that NFS exports may require that requests originate from a port less than 1024 (IPPORT_RESERVED). In this case, LocalPort should be manually specified.

The SecurityMechanism (and other related properties) may also be set beforehand. Please refer to the security section below for additional details.

Once set, the Connect method should be called to initiate a connection to the server. For example:

component.RemoteHost = "10.0.1.123"; component.RemotePort = 2049; component.Connect();

Once the connection is successful (or fails), the Connected event will fire accordingly, with details regarding the connection status. Assuming the connection was successful, the Connected property will be set to True.

After successfully connecting to the NFS server, the RemotePath will always be set to the root from the classes perspective, /.

If the server exports a specific directory (e.g., /mnt/mynfs), the class may need to navigate to this export manually by calling ChangeRemotePath with the relevant export path.

In some server-side configurations, the client may already start in the exported directory upon a connection, allowing immediate access without additional navigation.

Security

Before connecting to the server, the SecurityMechanism should be set accordingly. This property may be set to one of the following mechanisms:

System Authentication

By default, SecurityMechanism is set to sys, enabling RPC system authentication (AUTH_SYS). In this case, the RPCUid and RPCGid properties are used to specify the UID and GID the class should perform the request as. These properties are set to 0 by default, indicating root access.

NOTE: This mechanism is not secure. Network packets are still transferred in plaintext. This mechanism is only recommended for systems operating over a local network.

Kerberos Authentication

For additional security, the SecurityMechanism may be set to krb5, krb5i, or krb5p to enable RPC Kerberos authentication (RPCSEC_GSS).

It is important to note the differences between the listed Kerberos security mechanisms. If krb5 is utilized, Kerberos will only be used to perform client authentication.

If krb5i is utilized, Kerberos will be used to perform client authentication and integrity protection, ensuring that incoming and outgoing packets are untampered. However, packets remain unencrypted, making sensitive data potentially visible to anyone monitoring the network.

If krb5p is utilized, Kerberos will be used to perform client authentication, integrity protection, and packet encryption, making this the most secure option.

If the security mechanism is set to any of the Kerberos security mechanisms, the following properties must also be set accordingly:

• KDCHost
• KDCPort
• SPN
• User
• Password or KeytabFile

For example, connecting with a Kerberos security mechanism may look like:

// Configure general settings nfsclient.RemoteHost = "10.0.1.223"; nfsclient.RemotePort = 2049; nfsclient.SecurityMechanism = "krb5p"; // Configure kerberos settings nfsclient.KDCHost = "10.0.1.226"; nfsclient.User = "nfsclient@EXAMPLE.COM"; nfsclient.SPN = "nfs/nfs-server.example.com"; nfsclient.KeytabFile = "C:\\nfsclient.keytab"; // alternative to 'Password' nfsclient.Connect();

Lease Renewals

When a client initially connects to the server, it establishes a Client ID that is used for future operations. The server issues a lease that defines how long the client's stateful resources (such as open files) remain valid. The duration of this lease is indicated by the ServerLeaseTime property after successfully connecting to the server.

If the client does not perform any file operations within ServerLeaseTime seconds, the lease will expire. To prevent this, the Renew method can be called periodically to explicitly renew the lease.

For example, if ServerLeaseTime is 60 seconds and a file is downloaded using Download, the client has 60 seconds to perform another lease-refreshing operation or call Renew to avoid expiration.

The following methods automatically refresh the lease when called:

• Append
• CreateFile
• Download
• Open
• Read
• Write
• UpdateFileAttributes

If none of these methods are called within the lease period, call Renew before the timeout expires. To help with this, the LastRenewalTime config can be used to query the last time (in milliseconds) since the lease was last renewed, returning the number of milliseconds elapsed since the epoch (January 1, 1970 UTC). For example, you could regularly call the following to ensure the client lease is renewed within at least 5 seconds of the expected lease expiry time:

long lastRenewalTime; if (long.TryParse(c.Config("LastRenewalTime"), out lastRenewalTime)) { long now = (long)(DateTime.UtcNow - new DateTime(1970, 1, 1)).TotalMilliseconds; // milliseconds since epoch long elapsed = (now - lastRenewalTime) / 1000; // E.g., renew lease within 5 seconds of it expiring if (elapsed >= (c.ServerLeaseTime - 5)) { c.Renew(); } }

Alternatively, the class will automatically track the last renewal time internally. By calling DoEvents periodically, the lease can be renewed automatically.

By default, if DoEvents is called regularly, the component renews the lease up to RenewalThreshold seconds before it expires. For example, if ServerLeaseTime is 60 and RenewalThreshold is 10 (default), then DoEvents will trigger a renewal 50 seconds after the last file operation, assuming it is called at intervals shorter than RenewalThreshold.

This is especially important in forms-based applications, where DoEvents may not be called automatically in a tight loop. It is recommended to call DoEvents from a timer at intervals shorter than RenewalThreshold (e.g., less than once every 10 seconds).

For additional information, please see the descriptions for ServerLeaseTime, Renew, and RenewalThreshold.

Navigating the Server

As mentioned previously, upon successfully connecting to the NFS server, the RemotePath will always be set to the root from the classes perspective, /. ChangeRemotePath may or may not need to be called to navigate to the relevant server-side export.

Regardless, many methods operate based on the current working directory of the class as identified by RemotePath. For example, when calling ListDirectory, the directory contents of the current RemotePath will be listed.

As such, the ChangeRemotePath method can be used to change the current working directory of the class to some specified path. Both relative and absolute paths are supported with this method.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For example:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

Note that absolute and relative paths are supported for almost every class method that takes a file name and path as a parameter. Additionally, absolute and relative paths are supported by the RemoteFile property, which many methods make use of. For more information, please refer to the below section and individual method descriptions.

Managing Files and Directories

This section describes many different operations that can be performed on the NFS server. Before going into additional details, it is important to note that the behavior of many methods here operate depending on whether the specified RemoteFile or method parameter is an absolute or relative path.

If the specified RemoteFile or method parameter is an absolute path, the current RemotePath will be ignored in favor of the absolute path. However, if the specified RemoteFile or method parameter is a relative path, the operation will be performed relative to the current RemotePath.

File Lookup

To check whether a file or directory exists in the NFS server, the CheckFileExists method may be used. This method will search for the object specified by RemoteFile. For example:

// Relative Path component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; // Checks for test.txt in /home/testuser/myfolder if(component.CheckFileExists()) { component.Download(); } // Absolute Path component.RemoteFile = "/home/test/test.txt"; // Checks for test.txt in /home/test if(component.CheckFileExists()) { component.Download(); }

Listing Directories

To list the contents of a directory, the ListDirectory method should be called to retrieve the entries of the current working directory (as indicated by the current RemotePath).

The DirList event will fire for each entry in the current directory. The RemoteFile property may be used to specify a file mask for filtering the entries returned via DirList.

For example:

// List all text files in /home/test component.OnDirList += (o, e) => { Console.WriteLine("Dir Entry: " + e.FileName); }; component.ChangeRemotePath("/home/test"); component.RemoteFile = "*.txt"; component.ListDirectory();

NOTE: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to an empty string (or a mask like "*").

For more information about using RemoteFile as a filemask, please refer to the RemoteFile or ListDirectory documentation.

Create and Delete Objects

Files and directories may be created using CreateFile and MakeDirectory, respectively. Note that CreateFile is used to create a new file containing no data. To create a new file with content, please refer to the Upload method. For example:

// Create directory component.MakeDirectory("testdir"); // Create empty file in new directory component.ChangeRemotePath("testdir"); component.CreateFile("test.txt");

Files and directories may be deleted using DeleteFile and RemoveDirectory, respectively. For example (based on the previous directory structure in the last example):

// Remove file created previously component.ChangeRemotePath("testdir"); component.DeleteFile("test.txt"); // Navigate out of directory component.ChangeRemotePath("../"); component.RemoveDirectory("testdir");

Uploading Files

As mentioned, CreateFile may be used to create a new, empty file. To upload a file with content, the Upload method should be used. The RemoteFile property will specify the remote location to upload the local data to. If the RemoteFile exists and Overwrite is set to false, an error will occur while uploading.

The class can either upload the specified LocalFile, or upload the contents of a stream, which can be set via SetUploadStream. When uploading via a stream, the CloseStreamAfterTransfer config may be set to determine whether or not to close the stream after the transfer (enabled by default).

As an alternative to Upload, the Write method may be used to upload a specified number of bytes to a given position in the RemoteFile. This method can also be used to append data to the end of a file, however, the Append method may be also be used for this purpose. For specific examples, please refer to the documentation for each method.

Downloading Files

To download the content of a file hosted on the server, the Download method should be used. The RemoteFile property should be set to the remote file to download. The LocalFile property can be used to specify a local file to download the specified remote file to. If the LocalFile already exists and Overwrite is false, an error will occur.

The class can either download the remote file contents to the specified LocalFile, or download the contents to a stream, which can be set via SetDownloadStream. When downloading via a stream, the CloseStreamAfterTransfer config may be set to determine whether or not to close the stream after the transfer (enabled by default).

As an alternative to Download, the Read method may be used to download a specified number of bytes to some local buffer.

Lastly, as an alternative to LocalFile or SetDownloadStream, the downloaded file contents are also available in the Transfer event. Note the Transfer event will always fire containing the transferred data, so data may be retrieved here even if LocalFile is set or SetDownloadStream is called. For specific examples, please refer to the documentation for each method.

Creating and Reading Links

The class supports creating hard links and symbolic links using the CreateLink method.

CreateLink takes three parameters, the name of the link to be created, the target of the link, and the type of link (hard link or symbolic link). Please see below for a simple example:

nfs.ChangeRemotePath("/nfs"); // Create symlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("symlink.txt", "existing_file.txt", 0); // Create hardlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("hardlink.txt", "existing_file.txt", 1);

To read a hard link, you can set the RemoteFile property to the name of the hard link, and call Download (with the relevant local file or stream set).

However, reading a symbolic link requires some additional steps. First, the ReadLink method should be called, which will return a byte array containing the contents of the symbolic link as stored on the server. Typically, the contents are a file name that the link points to. Before going into detail, please see below for a simple example:

nfs.ChangeRemotePath("/nfs"); // Create symlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("symlink.txt", "existing_file.txt", 0); // Read link byte[] linkData = nfs.ReadLink("symlink.txt"); string file = Encoding.UTF8.GetString(linkData); nfs.RemoteFile = file; nfs.LocalFile = "temp.txt"; nfs.Download();

In NFS v4.0, the contents of a symbolic link are treated as opaque (binary data) at the protocol level. The server stores this opaque data and returns this to the client when requested, meaning it is up to the client to interpret the link data.

Most of the time, the opaque data will represent the file the symbolic link is pointing to relative to the position of the symbolic link, meaning it can be converted to a UTF8 string representing this file. The contents of the file should then be downloaded by setting RemoteFile (and possibly RemotePath) accordingly and calling Download.

Handling File Attributes

The class provides a couple of ways to handle file attributes. As mentioned previously, when calling ListDirectory, the DirList event will fire for each directory entry. During this event, the FileAttributes collection will be populated with the attributes of the associated directory entry. Note that the attributes are only meant to be retrieved during this event, rather than set.

Outside of DirList, the QueryFileAttributes method must be called to retrieve a file's attributes. After doing so, the FileAttributes property will be populated accordingly.

To update relevant file attributes, the FileAttributes property can be modified, and UpdateFileAttributes can be called to make those changes remotely. Note that not all attributes are able to be modified. Please see below for a simple example:

// First, query attributes component.RemoteFile = "/home/test/test.txt"; component.QueryFileAttributes(); // Update OwnerId and OwnerGroupId of file component.FileAttributes.OwnerId = "1000"; component.FileAttributes.OwnerGroupId = "1000"; component.UpdateFileAttributes();

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Connected Property (IPWorksNFS_NFSClient Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksnfs_nfsclient_get($res, 1 );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

FileAccessTime Property (IPWorksNFS_NFSClient Class)

Contains the number of seconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Object Oriented Interface

public function getFileAccessTime();
public function setFileAccessTime($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 2 );
ipworksnfs_nfsclient_set($res, 2, $value );

Default Value

0

Remarks

Contains the number of seconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

This property is not available at design time.

Data Type

Long64

FileAccessTimeNanos Property (IPWorksNFS_NFSClient Class)

Contains a subsecond value associated with this file's AccessTime .

Object Oriented Interface

public function getFileAccessTimeNanos();
public function setFileAccessTimeNanos($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 3 );
ipworksnfs_nfsclient_set($res, 3, $value );

Default Value

0

Remarks

Contains a subsecond value associated with this file's FileAccessTime.

This property is not available at design time.

Data Type

Integer

FileAllocationSize Property (IPWorksNFS_NFSClient Class)

Number of file system bytes allocated to this file object.

Object Oriented Interface

public function getFileAllocationSize();

Procedural Interface

ipworksnfs_nfsclient_get($res, 4 );

Default Value

0

Remarks

Number of file system bytes allocated to this file object.

This property is read-only and not available at design time.

Data Type

Long64

FileCreationTime Property (IPWorksNFS_NFSClient Class)

Specifies the number of seconds since 12:00:00 AM, January 1, 1970, when this file was created.

Object Oriented Interface

public function getFileCreationTime();

Procedural Interface

ipworksnfs_nfsclient_get($res, 5 );

Default Value

0

Remarks

Specifies the number of seconds since 12:00:00 AM, January 1, 1970, when this file was created.

This property is read-only and not available at design time.

Data Type

Long64

FileCreationTimeNanos Property (IPWorksNFS_NFSClient Class)

Contains a subsecond value associated with this file's CreationTime .

Object Oriented Interface

public function getFileCreationTimeNanos();

Procedural Interface

ipworksnfs_nfsclient_get($res, 6 );

Default Value

0

Remarks

Contains a subsecond value associated with this file's FileCreationTime.

This property is read-only and not available at design time.

Data Type

Integer

FileType Property (IPWorksNFS_NFSClient Class)

The type of file.

Object Oriented Interface

public function getFileType();

Procedural Interface

ipworksnfs_nfsclient_get($res, 7 );

Possible Values

NFSCLIENT_FILETYPE_REG(1), 
NFSCLIENT_FILETYPE_DIR(2), 
NFSCLIENT_FILETYPE_BLK(3), 
NFSCLIENT_FILETYPE_CHR(4), 
NFSCLIENT_FILETYPE_LNK(5), 
NFSCLIENT_FILETYPE_SOCK(6), 
NFSCLIENT_FILETYPE_FIFO(7), 
NFSCLIENT_FILETYPE_ATTRDIR(8), 
NFSCLIENT_FILETYPE_NAMEDATTR(9)

Default Value

0

Remarks

The type of file. FileType may be one of the following values:

This property is read-only and not available at design time.

Data Type

Integer

FileIsDir Property (IPWorksNFS_NFSClient Class)

Specifies whether or not the file represented by these attributes is a directory.

Object Oriented Interface

public function getFileIsDir();

Procedural Interface

ipworksnfs_nfsclient_get($res, 8 );

Default Value

false

Remarks

Specifies whether or not the file represented by these attributes is a directory.

This property is read-only and not available at design time.

Data Type

Boolean

FileIsSymlink Property (IPWorksNFS_NFSClient Class)

Specifies whether or not the file or directory represented by these attributes is a symbolic link.

Object Oriented Interface

public function getFileIsSymlink();

Procedural Interface

ipworksnfs_nfsclient_get($res, 9 );

Default Value

false

Remarks

Specifies whether or not the file or directory represented by these attributes is a symbolic link.

This property is read-only and not available at design time.

Data Type

Boolean

FileLinkCount Property (IPWorksNFS_NFSClient Class)

Number of hard links to this object.

Object Oriented Interface

public function getFileLinkCount();

Procedural Interface

ipworksnfs_nfsclient_get($res, 10 );

Default Value

0

Remarks

Number of hard links to this object.

This property is read-only and not available at design time.

Data Type

Integer

FileMIMEType Property (IPWorksNFS_NFSClient Class)

Specifies a value that can be used in the Content-Type header for a MIME entity part containing this file.

Object Oriented Interface

public function getFileMIMEType();

Procedural Interface

ipworksnfs_nfsclient_get($res, 11 );

Default Value

''

Remarks

Specifies a value that can be used in the Content-Type header for a MIME entity part containing this file.

This property is read-only and not available at design time.

Data Type

String

FileMode Property (IPWorksNFS_NFSClient Class)

Mode of a file.

Object Oriented Interface

public function getFileMode();
public function setFileMode($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 12 );
ipworksnfs_nfsclient_set($res, 12, $value );

Default Value

0

Remarks

Mode of a file

This property is not available at design time.

Data Type

Integer

FileModifiedTime Property (IPWorksNFS_NFSClient Class)

Specifies the number of seconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Object Oriented Interface

public function getFileModifiedTime();
public function setFileModifiedTime($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 13 );
ipworksnfs_nfsclient_set($res, 13, $value );

Default Value

0

Remarks

Specifies the number of seconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

This property is not available at design time.

Data Type

Long64

FileModifiedTimeNanos Property (IPWorksNFS_NFSClient Class)

Includes a subsecond value associated with this file's ModifiedTime .

Object Oriented Interface

public function getFileModifiedTimeNanos();
public function setFileModifiedTimeNanos($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 14 );
ipworksnfs_nfsclient_set($res, 14, $value );

Default Value

0

Remarks

Includes a subsecond value associated with this file's FileModifiedTime.

This property is not available at design time.

Data Type

Integer

FileOwnerGroupId Property (IPWorksNFS_NFSClient Class)

The string name of the group ownership of this object.

Object Oriented Interface

public function getFileOwnerGroupId();
public function setFileOwnerGroupId($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 15 );
ipworksnfs_nfsclient_set($res, 15, $value );

Default Value

''

Remarks

The string name of the group ownership of this object.

This property is not available at design time.

Data Type

String

FileOwnerId Property (IPWorksNFS_NFSClient Class)

The string name of the owner of this object.

Object Oriented Interface

public function getFileOwnerId();
public function setFileOwnerId($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 16 );
ipworksnfs_nfsclient_set($res, 16, $value );

Default Value

''

Remarks

The string name of the owner of this object.

This property is not available at design time.

Data Type

String

FileSize Property (IPWorksNFS_NFSClient Class)

Specifies the total size, in bytes, of this file.

Object Oriented Interface

public function getFileSize();
public function setFileSize($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 17 );
ipworksnfs_nfsclient_set($res, 17, $value );

Default Value

0

Remarks

Specifies the total size, in bytes, of this file.

This property is not available at design time.

Data Type

Long64

FirewallAutoDetect Property (IPWorksNFS_NFSClient Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 18 );
ipworksnfs_nfsclient_set($res, 18, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksNFS_NFSClient Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 19 );
ipworksnfs_nfsclient_set($res, 19, $value );

Possible Values

NFSCLIENT_FIREWALLTYPE_NONE(0), 
NFSCLIENT_FIREWALLTYPE_TUNNEL(1), 
NFSCLIENT_FIREWALLTYPE_SOCKS4(2), 
NFSCLIENT_FIREWALLTYPE_SOCKS5(3), 
NFSCLIENT_FIREWALLTYPE_SOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksNFS_NFSClient Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 20 );
ipworksnfs_nfsclient_set($res, 20, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksNFS_NFSClient Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 21 );
ipworksnfs_nfsclient_set($res, 21, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksNFS_NFSClient Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 22 );
ipworksnfs_nfsclient_set($res, 22, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

NOTE: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksNFS_NFSClient Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 23 );
ipworksnfs_nfsclient_set($res, 23, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

KDCHost Property (IPWorksNFS_NFSClient Class)

Specifies domain name or IP address of the Key Distribution Center (KDC).

Object Oriented Interface

public function getKDCHost();
public function setKDCHost($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 24 );
ipworksnfs_nfsclient_set($res, 24, $value );

Default Value

''

Remarks

This property specifies the domain name or IP address of the Key Distribution Center (KDC).

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

String

KDCPort Property (IPWorksNFS_NFSClient Class)

Specifies the port for the Key Distribution Center (KDC).

Object Oriented Interface

public function getKDCPort();
public function setKDCPort($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 25 );
ipworksnfs_nfsclient_set($res, 25, $value );

Default Value

88

Remarks

This property specifies the port for the Key Distribution Center (KDC). The default value is 88.

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

Integer

KeytabFile Property (IPWorksNFS_NFSClient Class)

Specifies the path to the Kerberos Keytab file.

Object Oriented Interface

public function getKeytabFile();
public function setKeytabFile($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 26 );
ipworksnfs_nfsclient_set($res, 26, $value );

Default Value

''

Remarks

This property specifies the path to a Kerberos Keytab file.

If specified, the credentials for a specific User are read from this file, assuming an entry for the user exists in the file. The Password should not be specified if using a Keytab file.

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

String

LocalFile Property (IPWorksNFS_NFSClient Class)

This is the path to a local file for download or upload. If the file exists, it is overwritten.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 27 );
ipworksnfs_nfsclient_set($res, 27, $value );

Default Value

''

Remarks

This property is used by the Upload and Download methods to specify the path to a local file to be downloaded or uploaded. See the method descriptions for more information.

Example (Setting LocalFile)

// Download remotefile.txt to C:\\localfile.txt component.LocalFile = "C:\\localfile.txt"; component.RemoteFile = "remotefile.txt"; component.Download(); // Upload C:\\localfile2.txt to folder/remotefile2.txt component.LocalFile = "C:\\localfile2.txt"; component.RemoteFile = "folder/remotefile2.txt"; component.Upload();

Data Type

String

LocalHost Property (IPWorksNFS_NFSClient Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 28 );
ipworksnfs_nfsclient_set($res, 28, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPWorksNFS_NFSClient Class)

The TCP port in the local host where the class binds.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 29 );
ipworksnfs_nfsclient_set($res, 29, $value );

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

NOTE: NFS exports may require that requests originate from a port less than 1024 (IPPORT_RESERVED). In this case, this property should be manually specified.

Data Type

Integer

Overwrite Property (IPWorksNFS_NFSClient Class)

This indicates whether the class should overwrite the local or remote file during a download or upload.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 30 );
ipworksnfs_nfsclient_set($res, 30, $value );

Default Value

false

Remarks

This property indicates whether the class should overwrite any local or remote files when calling Download, Upload, or CreateFile.

When uploading and Overwrite is false, an error will be thrown if the specified RemoteFile exists. When true, the RemoteFile will be overwritten.

When downloading and Overwrite is false, an error will be thrown if the specified LocalFile exists. When true, the LocalFile will be overwritten.

Data Type

Boolean

Password Property (IPWorksNFS_NFSClient Class)

Specifies the password of the User to authenticate.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 31 );
ipworksnfs_nfsclient_set($res, 31, $value );

Default Value

''

Remarks

This property specifies the password of the User to authenticate.

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

String

RemoteFile Property (IPWorksNFS_NFSClient Class)

This is the name of the remote file for uploading, downloading, and performing other operations.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 32 );
ipworksnfs_nfsclient_set($res, 32, $value );

Default Value

''

Remarks

This property contains the name of the remote file to be uploaded or downloaded and is either an absolute file path or a relative path based on the remote path set by calling ChangeRemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

component.LocalFile = "C:\\localfile.txt"; component.RemoteFile = "remotefile.txt"; component.Download(); component.LocalFile = "C:\\localfile2.txt"; component.RemoteFile = "folder/remotefile2.txt"; component.Download();

NOTE: This property will also act as a file mask when calling ListDirectory.

Example 2. Using RemoteFile as a file mask: component.RemoteFile = "*.txt" component.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. NOTE: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemoteHost Property (IPWorksNFS_NFSClient Class)

Specifies the address of the NFS server.

Object Oriented Interface

public function getRemoteHost();
public function setRemoteHost($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 33 );
ipworksnfs_nfsclient_set($res, 33, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the NFS server. It is set before a connection is attempted and should not be changed once a connection is established.

Data Type

String

RemotePath Property (IPWorksNFS_NFSClient Class)

Specifies the current path in the NFS server.

Object Oriented Interface

public function getRemotePath();

Procedural Interface

ipworksnfs_nfsclient_get($res, 34 );

Default Value

''

Remarks

This property specifies the current working directory on the NFS server. The ChangeRemotePath method can be used to change the working directory to an absolute path or to a relative path with respect to the current value of RemotePath.

Example. Changing Directory:

component.RemoteHost = "nfs.server.net"; component.RemotePort = 2049; component.Connect(); component.ChangeRemotePath("/home/user"); Console.WriteLine(component.RemotePath); // Outputs "/home/user"

This property is read-only.

Data Type

String

RemotePort Property (IPWorksNFS_NFSClient Class)

Specifies the port the NFS server is listening on.

Object Oriented Interface

public function getRemotePort();
public function setRemotePort($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 35 );
ipworksnfs_nfsclient_set($res, 35, $value );

Default Value

2049

Remarks

This property specifies the port the NFS server is listening on (i.e., the port the class will connect to).By default, this value is 2049.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

RPCGid Property (IPWorksNFS_NFSClient Class)

Specifies the group identifier (GID) associated with requests during RPC system authentication.

Object Oriented Interface

public function getRPCGid();
public function setRPCGid($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 36 );
ipworksnfs_nfsclient_set($res, 36, $value );

Default Value

0

Remarks

This property specifies the group identifier (GID) associated with requests during RPC system authentication (AUTH_SYS).

The specified GID will be sent in all outgoing requests in order to identify the relevant primary group of the user making the request. The user can be identified by the RPCUid property.

Note this property is only applicable when SecurityMechanism is set to sys.

Data Type

Integer

RPCUid Property (IPWorksNFS_NFSClient Class)

Specifies the user identifier (UID) associated with requests during RPC system authentication.

Object Oriented Interface

public function getRPCUid();
public function setRPCUid($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 37 );
ipworksnfs_nfsclient_set($res, 37, $value );

Default Value

0

Remarks

This property specifies the user identifier (UID) associated with requests during RPC system authentication (AUTH_SYS).

The specified UID will be sent in all outgoing requests in order to identify the user making the request.

Note this property is only applicable when SecurityMechanism is set to sys.

Data Type

Integer

SecurityMechanism Property (IPWorksNFS_NFSClient Class)

Specifies the RPC security mechanism the client should use when connecting to the NFS Server.

Object Oriented Interface

public function getSecurityMechanism();
public function setSecurityMechanism($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 38 );
ipworksnfs_nfsclient_set($res, 38, $value );

Default Value

'sys'

Remarks

This property specifies the RPC security mechanism the client should use when connecting to the NFS server.

This property may be set to one of the following mechanisms:

By default, this property is set to sys, and only system authentication is supported. When set to sys, the following properties may be set to specify the UID and GID the class should perform the request as:

• RPCUid
• RPCGid

Kerberos Security Mechanisms

It is important to note the differences between the listed Kerberos security mechanisms. If krb5 is utilized, Kerberos will only be used to perform client authentication.

If krb5i is utilized, Kerberos will be used to perform client authentication and integrity protection, ensuring that incoming and outgoing packets are untampered. However, packets remain unencrypted, making sensitive data potentially visible to anyone monitoring the network.

If krb5p is utilized, Kerberos will be used to perform client authentication, integrity protection, and packet encryption, making this the most secure option.

If the security mechanism is set to any of the Kerberos security mechanisms, the following properties must also be set accordingly:

• KDCHost
• KDCPort
• SPN
• User
• Password or KeytabFile

For example, connecting with a Kerberos security mechanism may look like:

// Configure general settings nfsclient.RemoteHost = "10.0.1.223"; nfsclient.RemotePort = 2049; nfsclient.SecurityMechanism = "krb5p"; // Configure kerberos settings nfsclient.KDCHost = "10.0.1.226"; nfsclient.User = "nfsclient@EXAMPLE.COM"; nfsclient.SPN = "nfs/nfs-server.example.com"; nfsclient.KeytabFile = "C:\\nfsclient.keytab"; // alternative to 'Password' nfsclient.Connect();

Data Type

String

ServerLeaseTime Property (IPWorksNFS_NFSClient Class)

Specifies the server-side lease time for the client.

Object Oriented Interface

public function getServerLeaseTime();

Procedural Interface

ipworksnfs_nfsclient_get($res, 39 );

Default Value

0

Remarks

This property specifies the server-side lease time for the client. This property is only meaningful after successfully connecting to the server.

When a client initially connects to the server, it establishes a Client ID that is used for future operations. The server issues a lease that defines how long the client's stateful resources (such as open files) remain valid. The duration of this lease is indicated by this property.

For additional details on how to use this property, please refer to the Renew method and RenewalThreshold configuration setting.

This property is read-only.

Data Type

Integer

SPN Property (IPWorksNFS_NFSClient Class)

Specifies the Service Principal Name (SPN).

Object Oriented Interface

public function getSPN();
public function setSPN($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 40 );
ipworksnfs_nfsclient_set($res, 40, $value );

Default Value

''

Remarks

This property specifies the Service Principal Name (SPN) that the User is attempting to access. This should be set to the SPN of the remote NFS Server, if applicable.

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

String

StartByte Property (IPWorksNFS_NFSClient Class)

The offset in bytes at which to begin the Upload or Download.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 41 );
ipworksnfs_nfsclient_set($res, 41, $value );

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer.

When downloading a file, this property specifies both the starting position in the RemoteFile to read from, as well as the starting position in the LocalFile (or stream, if using SetDownloadStream) to write to.

When uploading a file, this property specifies both the starting position in the LocalFile (or stream, if using SetUploadStream) to read from, as well as the starting position in the RemoteFile to write to.

Please see below for a simple example of resuming an upload:

long bytesTransferred = 0; component.OnTransfer += (o, e) => { bytesTransferred = e.BytesTransferred; }; component.LocalFile = "C:\nfs\test.txt"; component.RemoteFile = "test.txt"; bool uploadSuccessful = false; int maxRetries = 5; int retryCount = 0; while (!uploadSuccessful) { try { component.StartByte = bytesTransferred; // 0 initially, updated by Transfer event as necessary component.Upload(); uploadSuccessful = true; } catch (NFSSDKException ex) { retryCount++; if (retryCount >= maxRetries) { Console.WriteLine("Max retry attempts reached. Upload failed."); throw ex; } } }

Data Type

Long64

Timeout Property (IPWorksNFS_NFSClient Class)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 42 );
ipworksnfs_nfsclient_set($res, 42, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (IPWorksNFS_NFSClient Class)

Specifies the name and domain of the user to authenticate.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksnfs_nfsclient_get($res, 43 );
ipworksnfs_nfsclient_set($res, 43, $value );

Default Value

''

Remarks

This property specifies the name and realm/domain of the user to authenticate.

The value specified must be in one of the following formats:

• user@domain
• domain/user

Note that this property is only applicable when SecurityMechanism is set to krb5, krb5i, or krb5p.

Data Type

String

Abort Method (IPWorksNFS_NFSClient Class)

Aborts the current upload or download.

Object Oriented Interface

public function doAbort();

Procedural Interface

ipworksnfs_nfsclient_do_abort($res);

Remarks

This method is used to abort the current upload or download.

Append Method (IPWorksNFS_NFSClient Class)

Appends data from LocalFile to a remote file RemoteFile on a NFS server.

Object Oriented Interface

public function doAppend();

Procedural Interface

ipworksnfs_nfsclient_do_append($res);

Remarks

This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as with the Upload method. RemoteFile is either an absolute path on the server or a path relative to RemotePath. The server will create a file with that name if it does not already exist (similar to upload).

ChangeRemotePath Method (IPWorksNFS_NFSClient Class)

Changes the current path on the server.

Object Oriented Interface

public function doChangeRemotePath($remotepath);

Procedural Interface

ipworksnfs_nfsclient_do_changeremotepath($res, $remotepath);

Remarks

This method changes the current path on the server to the specified RemotePath parameter. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

The current path on the server can be found by querying the RemotePath property.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For example:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

CheckFileExists Method (IPWorksNFS_NFSClient Class)

Checks whether the file specified by RemoteFile exists on the server.

Object Oriented Interface

public function doCheckFileExists();

Procedural Interface

ipworksnfs_nfsclient_do_checkfileexists($res);

Remarks

This method checks whether the file specified by RemoteFile exists on the server. If the file exists, this method returns true, otherwise it returns false. RemoteFile must be specified before calling this method.

The RemoteFile can either specify the absolute path to the file, or a relative path based on the current working directory (indicated by the RemotePath property). For instance:

// Relative Path component.ChangeRemotePath("/home/testuser/myfolder"); component.RemoteFile = "test.txt"; // Checks for test.txt in /home/testuser/myfolder if(component.CheckFileExists()) { component.Download(); } // Absolute Path component.RemoteFile = "/home/test/test.txt"; // Checks for test.txt in /home/test if(component.CheckFileExists()) { component.Download(); }

Close Method (IPWorksNFS_NFSClient Class)

This method is used to close an open file.

Object Oriented Interface

public function doClose($path, $filename);

Procedural Interface

ipworksnfs_nfsclient_do_close($res, $path, $filename);

Remarks

This method is used to close a remote file that was previously opened using Open.

Once the file is closed, the Read and Write methods cannot be called for this specific resource until the file is opened again. This method should be called after completing all read and write operations.

Please see below for an example:

component.Open("/home/test", "test.txt", 3, 0); // Open remote file for read/write. byte[] buffer = Encoding.UTF8.GetBytes("Partial update data"); component.Write("/home/test", "test.txt", 100, buffer.Length, buffer); // Write to file. component.Close("/home/test", "test.txt"); // Close the file when done.

Config Method (IPWorksNFS_NFSClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksnfs_nfsclient_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (IPWorksNFS_NFSClient Class)

This method connects to the NFS server.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksnfs_nfsclient_do_connect($res);

Remarks

This method establishes a connection with the NFS server specified by RemoteHost and RemotePort.

Prior to calling this method, the SecurityMechanism should be set appropriately, along with properties relevant to the specified mechanism. For example:

component.RemoteHost = "10.0.1.67"; component.RemotePort = 2049; component.Connect();

CreateFile Method (IPWorksNFS_NFSClient Class)

Creates a file on the NFS server.

Object Oriented Interface

public function doCreateFile($filename);

Procedural Interface

ipworksnfs_nfsclient_do_createfile($res, $filename);

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter.

If the specified FileName already exists, and Overwrite is false, an error will be thrown.

To upload a file with content, use Upload instead.

CreateLink Method (IPWorksNFS_NFSClient Class)

Creates a hard link or symbolic link on the server.

Object Oriented Interface

public function doCreateLink($linkname, $linktarget, $linktype);

Procedural Interface

ipworksnfs_nfsclient_do_createlink($res, $linkname, $linktarget, $linktype);

Remarks

This method is used to create a hard link or symbolic link on the server.

The LinkName parameter is the name of the link to create, and is either an absolute path on the server or a path relative to RemotePath.

The LinkTarget parameter specifies the target of the link.

The LinkType parameter indicates what type of link the class should attempt to create. Possible values are 0 or 1.

If specified as 0, the class will attempt to create a symbolic link pointing to the data (typically a file name) specified by the LinkTarget parameter.

If specified as 1, the class will attempt to create a hard link pointing to the file name specified by the LinkTarget parameter. Note that in this case, the LinkTarget is either an absolute path on the server or a path relative to RemotePath. Please see below for a simple example.

nfs.ChangeRemotePath("/nfs"); // Create symlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("symlink.txt", "existing_file.txt", 0); // Create hardlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("hardlink.txt", "existing_file.txt", 1);

DeleteFile Method (IPWorksNFS_NFSClient Class)

This method removes a file specified by FileName from the server.

Object Oriented Interface

public function doDeleteFile($filename);

Procedural Interface

ipworksnfs_nfsclient_do_deletefile($res, $filename);

Remarks

This method is used to remove a file specified by FileName from the server. The remote file or directory specified by FileName is deleted.

The FileName parameter is either an absolute path on the server, or a path relative to remote path set by ChangeRemotePath. For example:

// Delete test.txt in /home/test directory component.ChangeRemotePath("/home/test"); component.DeleteFile("test.txt"); // Alternatively... component.DeleteFile("/home/test/test.txt");

Disconnect Method (IPWorksNFS_NFSClient Class)

This method disconnects from the NFS server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksnfs_nfsclient_do_disconnect($res);

Remarks

This method is used to disconnect from the NFS server.

DoEvents Method (IPWorksNFS_NFSClient Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksnfs_nfsclient_do_doevents($res);

Remarks

The method checks for events to process, such as incoming data, and fires corresponding events as necessary. If there are no events to process, the method waits for a time specified by the SelectWaitMillis configuration setting before returning.

Windows: By default, the server socket uses Windows messages, and DoEvents dispatches Windows messages internally. It is not necessary to call DoEvents from Windows GUI applications as these applications have an internal message dispatch loop. When called, this method must be called in the same thread or task in which the StartListening and StopListening methods are called.

To avoid using Windows messages and a dispatch loop, set UseWindowsMessages to false. The application still needs to call this DoEvents method to let the class handle socket updates, but when Windows messages are not used, DoEvents and StopListening may be called from a separate thread or task.

Linux: The method may be called from any worker thread, and events will fire in this thread.

macOS: In GUI applications, it is not necessary to call this method as the class registers itself in the main message loop. In other applications, the method may be called from any worker thread, and events will fire in this thread.

Download Method (IPWorksNFS_NFSClient Class)

This method downloads a remote file from the NFS server.

Object Oriented Interface

public function doDownload();

Procedural Interface

ipworksnfs_nfsclient_do_download($res);

Remarks

This method is used to download a remote file, specified by RemoteFile, from the NFS server.

The LocalFile property can be used to specify a local file to download the specified remote file to. If the LocalFile already exists and Overwrite is false, an error will occur.

Alternatively, the SetDownloadStream method can be called to download the file contents to the specified stream. In this case, calling SetDownloadStream will automatically reset the value of LocalFile.

As an alternative to setting LocalFile or calling SetDownloadStream, the downloaded file contents are also available in the Transfer event. Note that the downloaded data is always available via Transfer, regardless of whether the data is downloaded to a stream or file (or neither).

For example:

// Using LocalFile component.RemoteFile = "/home/test/test.txt"; component.LocalFile = "C:\\nfsdir\\test.txt"; component.Download(); // Using SetDownloadStream FileStream fs = new FileStream("C:\\nfsdir\\test.txt", FileMode.Open); component.RemoteFile = "/home/test/test.txt"; component.SetDownloadStream(fs); component.Download();

ListDirectory Method (IPWorksNFS_NFSClient Class)

This method lists the current working directory on the NFS server.

Object Oriented Interface

public function doListDirectory();

Procedural Interface

ipworksnfs_nfsclient_do_listdirectory($res);

Remarks

This method is used to list the current working directory on the NFS server, as indicated by the current RemotePath.

The DirList event will fire for each entry in the current directory. The RemoteFile property may be used to specify a file mask for filtering the entries returned via DirList.

For example:

// List all text files in /home/test component.OnDirList += (o, e) => { Console.WriteLine("Dir Entry: " + e.FileName); }; component.ChangeRemotePath("/home/test"); component.RemoteFile = "*.txt"; component.ListDirectory();

NOTE: Because RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to an empty string (or a mask like "*").

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. NOTE: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

MakeDirectory Method (IPWorksNFS_NFSClient Class)

This method is used to create a directory on the NFS server.

Object Oriented Interface

public function doMakeDirectory($newdir);

Procedural Interface

ipworksnfs_nfsclient_do_makedirectory($res, $newdir);

Remarks

This method is used to create a directory with a path specified by NewDir on the NFS server.

NewDir is either an absolute path on the server, or a path relative to the RemotePath that is set by calling ChangeRemotePath.

Open Method (IPWorksNFS_NFSClient Class)

This method is used to open a remote file for reading and/or writing operations.

Object Oriented Interface

public function doOpen($path, $filename, $shareaccess, $sharedeny);

Procedural Interface

ipworksnfs_nfsclient_do_open($res, $path, $filename, $shareaccess, $sharedeny);

Remarks

This method is used to open a remote file specified by the Path and FileName parameters. Once a file is open, data can be read from or written to the file using the Read and/or Write methods.

The ShareAccess and ShareDeny parameters specify the desired access mode and share reservations for the file. These control whether the client intends to read from a file, write to a file, or both, and whether other clients may access the file concurrently.

This method is intended to be used with Read and/or Write, and Close, and provides finer control over file operations compared to the Upload and Download methods. It is designed for scenarios where an application needs to transfer partial data, perform incremental updates, or maintain an open handle for multiple read/write operations without repeatedly reopening the file.

Possible values for ShareAccess are as follows:

Possible values for ShareDeny are as follows:

Once a file is opened, the Read and/or Write methods may be called with the relevant Path and FileName parameters as specified here. After a file is finished being read from or written to, please be sure to call the Close method. Please see below for an example:

component.Open("/home/test", "test.txt", 3, 0); // Open remote file for read/write, deny access to none. ... byte[] buffer = new byte[1000]; component.Read("/home/test", "test.txt", 0, 1000, buffer); // Read 1000 bytes of the remote file into buffer. ... component.Write("/home/test", "test.txt", 0, 1000, buffer); // Write 1000 bytes from the buffer to the remote file. ... component.Close("/home/test", "test.txt");

QueryFileAttributes Method (IPWorksNFS_NFSClient Class)

This method queries the server for the file attributes of the specified RemoteFile .

Object Oriented Interface

public function doQueryFileAttributes();

Procedural Interface

ipworksnfs_nfsclient_do_queryfileattributes($res);

Remarks

This method is used to query the server for file attributes of the specified RemoteFile. After calling this method, the FileAttributes property will be populated with the values returned by the server.

To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes. Please see below for a simple example:

// First, query attributes component.RemoteFile = "/home/test/test.txt"; component.QueryFileAttributes(); // Update OwnerId and OwnerGroupId of file component.FileAttributes.OwnerId = "1000"; component.FileAttributes.OwnerGroupId = "1000"; component.UpdateFileAttributes();

Read Method (IPWorksNFS_NFSClient Class)

This method is used to read data from an open remote file.

Object Oriented Interface

public function doRead($path, $filename, $startbyte, $count, $buffer);

Procedural Interface

ipworksnfs_nfsclient_do_read($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

This method is used to read a specified number of bytes from an open remote file, as specified by the Path and FileName parameters. This method can only be called for the specified remote file after successfully opening the file using Open.

The StartByte parameter specifies the byte offset (relative to the beginning of the file) from which the class should begin reading data.

The Count parameter specifies the number of bytes to read from the file starting at the StartByte position.

A byte array should be passed to the class via the Buffer parameter, which will hold the bytes read by the class after the method returns. The method will return the actual number of bytes read into this parameter.

This functionality is particularly useful for efficient management of large files and targeted data retrieval within them. Additionally, the Open and Close methods enable persistent file access across multiple read or write operations. This reduces overhead and improves performance in scenarios that require many consecutive partial read and write operations.

If the requested range extends beyond the end of the file, only the available bytes will be returned. The method's return value indicates the number of bytes successfully read.

Please see below for an example:

component.Open("/home/test", "test.txt", 1, 0); // Open remote file for reading. byte[] buffer = new byte[1024]; int bytesRead = component.Read("/home/test", "test.txt", 0, 1024, buffer); // Read first 1024 bytes. ... // Perform any number of additional read operations, then close. component.Close("/home/test", "test.txt");

ReadLink Method (IPWorksNFS_NFSClient Class)

Reads a symbolic link on the server.

Object Oriented Interface

public function doReadLink($linkname);

Procedural Interface

ipworksnfs_nfsclient_do_readlink($res, $linkname);

Remarks

This method is used to read a symbolic link on the server.

The LinkName parameter specifies the name of the symbolic link, and is either an absolute path on the server or a path relative to RemotePath.

This method will return a byte array containing the contents of the symbolic link as stored on the server. In NFS v4.0, the contents of a symbolic link are treated as opaque (binary data) at the protocol level. The server simply stores this opaque data, and returns this to the client when requested, meaning it is up to the client to interpret the link data.

Most of the time, the opaque data will represent the file the symbolic link is pointing to relative to the position of the symbolic link, meaning it can be converted to a UTF8 string representing this file. The contents of the file should then be downloaded by setting RemoteFile (and possibly RemotePath) accordingly and calling Download.

Please see below for a simple example of reading the contents of a symbolic link, and reading the file pointed to by the symbolic link.

nfs.ChangeRemotePath("/nfs"); // Create symlink.txt in /nfs pointing to existing_file.txt in the same directory nfs.CreateLink("symlink.txt", "existing_file.txt", 0); // Read link byte[] linkData = nfs.ReadLink("symlink.txt"); string file = Encoding.UTF8.GetString(linkData); nfs.RemoteFile = file; nfs.LocalFile = "temp.txt"; nfs.Download();

RemoveDirectory Method (IPWorksNFS_NFSClient Class)

This removes a directory specified by DirName from the NFS server.

Object Oriented Interface

public function doRemoveDirectory($dirname);

Procedural Interface

ipworksnfs_nfsclient_do_removedirectory($res, $dirname);

Remarks

This method is used to remove a directory with path specified by DirName from the NFS server. DirName is either an absolute path on the server, or a path relative to the RemotePath that is set by calling ChangeRemotePath.

RenameFile Method (IPWorksNFS_NFSClient Class)

This changes the name of RemoteFile to NewName .

Object Oriented Interface

public function doRenameFile($newname);

Procedural Interface

ipworksnfs_nfsclient_do_renamefile($res, $newname);

Remarks

This method is used to change the name of a remote file, specified by RemoteFile, to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath that is set by calling ChangeRemotePath.

Renew Method (IPWorksNFS_NFSClient Class)

Renew the lease associated with the client's current Client ID on the server.

Object Oriented Interface

public function doRenew();

Procedural Interface

ipworksnfs_nfsclient_do_renew($res);

Remarks

This method is used to renew the lease associated with the client's current Client ID on the server.

When a client initially connects to the server, it establishes a Client ID that is used for future operations. The server issues a lease that defines how long the client's stateful resources (such as open files) remain valid. The duration of this lease is indicated by the ServerLeaseTime property after successfully connecting to the server.

If the client does not perform any file operations within ServerLeaseTime seconds, the lease will expire. To prevent this, the Renew method can be called periodically to explicitly renew the lease.

For example, if ServerLeaseTime is 60 seconds and a file is downloaded using Download, the client has 60 seconds to perform another lease-refreshing operation or call Renew to avoid expiration.

The following methods automatically refresh the lease when called:

• Append
• CreateFile
• Download
• Open
• Read
• Write
• UpdateFileAttributes

If none of these methods are called within the lease period, call Renew before the timeout expires. To help with this, the LastRenewalTime config can be used to query the last time (in milliseconds) since the lease was last renewed, returning the number of milliseconds elapsed since the epoch (January 1, 1970 UTC). For example, you could regularly call the following to ensure the client lease is renewed within at least 5 seconds of the expected lease expiry time:

long lastRenewalTime; if (long.TryParse(c.Config("LastRenewalTime"), out lastRenewalTime)) { long now = (long)(DateTime.UtcNow - new DateTime(1970, 1, 1)).TotalMilliseconds; // milliseconds since epoch long elapsed = (now - lastRenewalTime) / 1000; // E.g., renew lease within 5 seconds of it expiring if (elapsed >= (c.ServerLeaseTime - 5)) { c.Renew(); } }

Alternatively, the class will automatically track the last renewal time internally. By calling DoEvents periodically, the lease can be renewed automatically.

By default, if DoEvents is called regularly, the component renews the lease up to RenewalThreshold seconds before it expires. For example, if ServerLeaseTime is 60 and RenewalThreshold is 10 (default), then DoEvents will trigger a renewal 50 seconds after the last file operation, assuming it is called at intervals shorter than RenewalThreshold.

This is especially important in forms-based applications, where DoEvents may not be called automatically in a tight loop. It is recommended to call DoEvents from a timer at intervals shorter than RenewalThreshold (e.g., less than once every 10 seconds).

Reset Method (IPWorksNFS_NFSClient Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksnfs_nfsclient_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

UpdateFileAttributes Method (IPWorksNFS_NFSClient Class)

This method updates the FileAttributes for the current RemoteFile .

Object Oriented Interface

public function doUpdateFileAttributes();

Procedural Interface

ipworksnfs_nfsclient_do_updatefileattributes($res);

Remarks

This method is used to update the FileAttributes for the current RemoteFile. After calling this method, the class will send any set FileAttributes to the server.

For example:

// First, query attributes component.RemoteFile = "/home/test/test.txt"; component.QueryFileAttributes(); // Update OwnerId and OwnerGroupId of file component.FileAttributes.OwnerId = "1000"; component.FileAttributes.OwnerGroupId = "1000"; component.UpdateFileAttributes();

Upload Method (IPWorksNFS_NFSClient Class)

This method uploads a file to the NFS server.

Object Oriented Interface

public function doUpload();

Procedural Interface

ipworksnfs_nfsclient_do_upload($res);

Remarks

This method is used to upload a file to the NFS server.

The RemoteFile property is used to specify the remote location to upload the local data to. If the RemoteFile already exists and Overwrite is false, an error will occur while uploading.

The LocalFile property can be used to specify a local file to upload to the specified remote location.

Alternatively, the SetUploadStream method can be called to upload the contents of a given stream. In this case, calling SetUploadStream will automatically reset the value of LocalFile.

The uploaded data will be made available in the Transfer event. Please see below for a simple example.

// Using LocalFile component.LocalFile = "C:\\nfsdir\\test.txt"; component.RemoteFile = "/home/test/test.txt"; component.Upload(); // Using SetDownloadStream FileStream fs = new FileStream("C:\\nfsdir\\test.txt", FileMode.Open); component.SetUploadStream(fs); component.RemoteFile = "/home/test/test.txt"; component.Upload();

Write Method (IPWorksNFS_NFSClient Class)

This method is used to write data to an open remote file.

Object Oriented Interface

public function doWrite($path, $filename, $startbyte, $count, $buffer);

Procedural Interface

ipworksnfs_nfsclient_do_write($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

This method is used to write a specified number of bytes to an open remote file, as specified by the Path and FileName parameters. This method can only be called for the specified remote file after successfully opening the file using Open.

The StartByte parameter specifies the byte offset (relative to the beginning of the file) where the class should begin writing data.

The Count parameter specifies the number of bytes to write from the provided Buffer into the remote file.

The Buffer parameter contains the data to be uploaded to the remote file. The method writes Count bytes from this buffer starting at the specified StartByte offset.

This functionality is particularly useful for efficient management of large files and incremental updates. Additionally, the Open and Close methods enable persistent file access across multiple read or write operations. This reduces overhead and improves performance in scenarios that require many consecutive partial read and write operations.

If the specified offset (StartByte) is beyond the current end of the file, empty bytes will be created between the last existing byte and the uploaded data to preserve file continuity.

Please see below for an example:

component.Open("/home/test", "test.txt", 3, 0); // Open remote file for read/write. byte[] buffer = Encoding.UTF8.GetBytes("Updated data block"); component.Write("/home/test", "test.txt", 0, buffer.Length, buffer); // Write data starting at byte offset 0. ... // Perform any number of additional write operations, then close. component.Close("/home/test", "test.txt");

Connected Event (IPWorksNFS_NFSClient Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

DirList Event (IPWorksNFS_NFSClient Class)

This event fires when a directory entry is received.

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 2, array($this, 'fireDirList'));

Parameter List

 'filename'
 'isdir'
 'filesize'
 'filetime'
 'issymlink'

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory call.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The FileName parameter contains the filename when ListDirectory is called.

The class reports the IsDir, FileSize, FileTime, and IsSymlink parameters when calling ListDirectory as well.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

Disconnected Event (IPWorksNFS_NFSClient Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

This event is fired when a connection is closed.

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode will be non-zero, and the Description parameter will contain a description of this code.

EndTransfer Event (IPWorksNFS_NFSClient Class)

This event is fired when a file finishes uploading or downloading.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

This event is fired when a file is finished uploading or downloading.

This occurs when a file is finished transferring after calling Upload, Write, Download, and Read.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IPWorksNFS_NFSClient Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksNFS_NFSClient Class)

This event is fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are as follows:

• NFS

StartTransfer Event (IPWorksNFS_NFSClient Class)

This event is fired when a file starts uploading or downloading.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 7, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

This event is fired when a file starts uploading or downloading.

This occurs immediately before a file starts transferring after calling Upload, Write, Download, and Read.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (IPWorksNFS_NFSClient Class)

This event is fired during the file download or upload.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksnfs_nfsclient_register_callback($res, 8, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (NFSClient Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

NfsClient Config Settings

Base Config Settings

Trappable Errors (NFSClient Class)

NFSCLIENT Errors