FSync Event

Fires when the OS needs to flush an open file's data out to storage.

Syntax

• C#
• VB.NET

public event OnFSyncHandler OnFSync;

public delegate void OnFSyncHandler(object sender, FuseFSyncEventArgs e);

public class FuseFSyncEventArgs : EventArgs {
  public string Path { get; }
  public int FileContext { get; }
  public int DataSync { get; }
  public int Result { get; set; }
}

Public Event OnFSync As OnFSyncHandler

Public Delegate Sub OnFSyncHandler(sender As Object, e As FuseFSyncEventArgs)

Public Class FuseFSyncEventArgs Inherits EventArgs
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileContext As Integer
  Public ReadOnly Property DataSync As Integer
  Public Property Result As Integer
End Class

Remarks

This event fires when the OS needs the virtual filesystem to flush data of the file out to storage which can happen at any time while the file is opened. The file to flush is identified by either Path or FileContext.

To handle this event properly, applications must flush the requested data, writing it out to their backend storage.

Linux: The non-zero of DataSync parameter indicates that only the user data should be flushed and not the metadata.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a negative error code value (e.g. -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.