blob: ea6c634e1f58ffc1ef9acd3eb5b222f8d637fe8f [file] [log] [blame]
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
/**
* MountFlag is a bit mask of options to the mount call.
* @name MountFlag
* @constructor
* @param {number} bitMask MountFlag bit mask
* @memberof module:vanadium.naming
*/
/**
* Replace means the mount should replace what is currently at the mount point
* @name Replace
* @constant
* @type {module:vanadium.naming.MountFlag}
* @memberof module:vanadium.naming
*/
/**
* MT means that the target server is a mount table.
* @name MT
* @constant
* @type {module:vanadium.naming.MountFlag}
* @memberof module:vanadium.naming
*/
/**
* MountedServer represents a server mounted on a specific name.
* @name MountedServer
* @constructor
* @param {Object} mountedServer
* @param {string} mountedServer.server Server is the OA that's mounted.
* @param {string[]} mountedServer.blessingPatterns Patterns that match the set
* of blessings presented by the server listening on the above object address.
* @param {number} mountedServer.deadline deadline before the mount entry
* expires.
* @memberof module:vanadium.naming
*/
/**
* MountEntry represents a given name mounted in the mounttable.
* @name MountEntry
* @constructor
* @param {Object} mountEntry
* @param {string} mountEntry.name Name is the mounted name.
* @param {module:vanadium.naming.MountedServer[]} mountEntry.servers Servers
* (if present) specifies the mounted names.
* @param {boolean} mountEntry.servesMountTable servesMountTable is true if the
* servers represent mount tables.
* @memberof module:vanadium.naming
*/
/**
* GlobError is returned by namespace.Glob to indicate a subtree of the
* namespace that could not be traversed.
* @name GlobError
* @constructor
* @param {Object} globError
* @param {string} globError.name Name Root of the subtree.
* @param {module.vanadium.verror.VanadiumError} globError.error The error that
* occurred fulfilling the request.
* @memberof module:vanadium.naming
*/
/**
* GlobReply is the data type of the chan returned by Glob__.
* It is a union type of MountEntry and GlobError
* @name GlobReply
* @constructor
* @param {Object} globReply
* @param {module:vanadium.naming.MountEntry} globReply.entry
* @param {module:vanadium.naming.GlobError} globReply.error
* @memberof module:vanadium.naming
*/