Trait NodeServerHandler

pub trait NodeServerHandler<___T: Transport> {
    // Required methods
    fn clone(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, Clone>,
    );
    fn close(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<Close>,
    );
    fn query(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<Query>,
    );
    fn deprecated_clone(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, DeprecatedClone>,
    );
    fn get_attr(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<GetAttr>,
    );
    fn set_attr(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, SetAttr>,
        responder: Responder<SetAttr>,
    );
    fn deprecated_get_flags(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<DeprecatedGetFlags>,
    );
    fn deprecated_set_flags(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, DeprecatedSetFlags>,
        responder: Responder<DeprecatedSetFlags>,
    );
    fn get_flags(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<GetFlags>,
    );
    fn set_flags(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, SetFlags>,
        responder: Responder<SetFlags>,
    );
    fn query_filesystem(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<QueryFilesystem>,
    );
    fn get_connection_info(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<GetConnectionInfo>,
    );
    fn get_attributes(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, GetAttributes>,
        responder: Responder<GetAttributes>,
    );
    fn update_attributes(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, UpdateAttributes>,
        responder: Responder<UpdateAttributes>,
    );
    fn sync(
        &mut self,
        sender: &ServerSender<___T, Node>,
        responder: Responder<Sync>,
    );
    fn list_extended_attributes(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, ListExtendedAttributes>,
    );
    fn get_extended_attribute(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, GetExtendedAttribute>,
        responder: Responder<GetExtendedAttribute>,
    );
    fn set_extended_attribute(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, SetExtendedAttribute>,
        responder: Responder<SetExtendedAttribute>,
    );
    fn remove_extended_attribute(
        &mut self,
        sender: &ServerSender<___T, Node>,
        request: RequestBuffer<___T, RemoveExtendedAttribute>,
        responder: Responder<RemoveExtendedAttribute>,
    );

    // Provided method
    fn on_unknown_interaction(
        &mut self,
        sender: &ServerSender<___T, Node>,
        ordinal: u64,
    ) { ... }
}

A server handler for the Node protocol.

See Node for more details.

Required Methods

fn clone( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, Clone>, )

fn close( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<Close>, )

Terminates the connection.

After calling Close, the client must not send any other requests.

Servers, after sending the status response, should close the connection regardless of status and without sending an epitaph.

Closing the client end of the channel should be semantically equivalent to calling Close without knowing when the close has completed or its status.

fn query( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<Query>, )

fn deprecated_clone( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, DeprecatedClone>, )

DEPRECATED - Use fuchsia.unknown/Cloneable.Clone instead.

fn get_attr( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<GetAttr>, )

Acquires information about the node.

This method does not require any rights.

fn set_attr( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, SetAttr>, responder: Responder<SetAttr>, )

Updates information about the node.

Returns ZX_ERR_NOT_SUPPORTED if any attributes specified by [flags] are not supported.

This method requires following rights: OpenFlags.RIGHT_WRITABLE, otherwise returns ZX_ERR_BAD_HANDLE.

fn deprecated_get_flags( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<DeprecatedGetFlags>, )

[DEPRECATED - Use new GetFlags method instead.]

fn deprecated_set_flags( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, DeprecatedSetFlags>, responder: Responder<DeprecatedSetFlags>, )

[DEPRECATED - Use new SetFlags method instead.]

fn get_flags( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<GetFlags>, )

Queries the flags that apply to this node after it has been opened/created. This method does not require any rights.

Note that the final set of flags that apply to the connection may differ from those specified with the fuchsia.io/Directory.Open request used to create it:

• Flags.PERM_INHERIT_*: Only applies when determining connection rights.
• Flags.PROTOCOL_*: Only the protocol of the connection will be present.
• Flags.FLAG_*: Only applies when opening the resource, not part of the connection.

fn set_flags( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, SetFlags>, responder: Responder<SetFlags>, )

Sets the flags that apply to this node after it has been opened. This method does not require any rights.

Only Flags.FILE_APPEND is currently supported. Calling this method without any flags will clear append mode.

Errors:

• ZX_ERR_NOT_SUPPORTED: The object does not support this feature or the specified flags.
• ZX_ERR_INVALID_ARGS: flags other than Flags.FILE_APPEND were specified.

fn query_filesystem( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<QueryFilesystem>, )

Query the filesystem for filesystem-specific information.

fn get_connection_info( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<GetConnectionInfo>, )

Acquires information about the connection.

This method does not require any rights.

fn get_attributes( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, GetAttributes>, responder: Responder<GetAttributes>, )

Acquires information about the node.

The attributes of a node should be stable, independent of the specific protocol used to access it.

If a particular attribute is not applicable or not supported, filesystems should leave the corresponding field absent.

• query a bit-mask specifying which attributes to fetch. The server should not return more than necessary.

• attributes the returned attributes.

This method requires the [Rights.GET_ATTRIBUTES] right.

fn update_attributes( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, UpdateAttributes>, responder: Responder<UpdateAttributes>, )

Updates information about the node.

• attributes the presence of a table field in attributes indicates the intent to update the corresponding attribute.

Returns ZX_ERR_NOT_SUPPORTED if the node does not support any of the specified attributes.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

fn sync( &mut self, sender: &ServerSender<___T, Node>, responder: Responder<Sync>, )

Synchronizes updates to the node to the underlying media, if it exists.

This method will return when the filesystem server has flushed the relevant updates to the underlying media, but does not guarantee the underlying media has persisted the information, nor that any information is committed to hardware. Clients may use Sync to ensure ordering between operations.

This method does not require any rights.

fn list_extended_attributes( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, ListExtendedAttributes>, )

Creates an iterator over all the extended attribute names associated with this node. If an error occurs it is returned as an epitaph on the iterator request channel, and then the channel is closed.

GetExtendedAttributes can be used with any of these names to retrieve the associated value.

This method requires the [Rights.GET_ATTRIBUTES] right.

fn get_extended_attribute( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, GetExtendedAttribute>, responder: Responder<GetExtendedAttribute>, )

Get the value associated with the given attribute name for this node.

Attribute names have a maximum length of MAX_ATTRIBUTE_NAME. No particular structure is imposed on them.

This method requires the [Rights.GET_ATTRIBUTES] right.

fn set_extended_attribute( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, SetExtendedAttribute>, responder: Responder<SetExtendedAttribute>, )

Set the value for the given attribute name to value for this node.

The attribute name may exist, in which case the attribute is updated. If the attribute doesn’t exist, it is created. The name should have no null bytes in it. If it does, ZX_ERR_INVALID_ARGS is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

fn remove_extended_attribute( &mut self, sender: &ServerSender<___T, Node>, request: RequestBuffer<___T, RemoveExtendedAttribute>, responder: Responder<RemoveExtendedAttribute>, )

Remove the specified extended attribute.

If the attribute doesn’t exist, ZX_ERR_NOT_FOUND is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

Provided Methods

fn on_unknown_interaction( &mut self, sender: &ServerSender<___T, Node>, ordinal: u64, )

Implementors