/*
 * Copyright (c) 2012-2013, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*
 *  ======== INameServerRemote.xdc ========
 *
 */

import xdc.runtime.Error;

/*!
 *  ======== INameServerRemote ========
 *  Interface for remote NameServer accesses
 */
interface INameServerRemote {

    /*!
     *  ======== Status ========
     *  Status codes returned by certain calls
     */
    enum Status {
        S_SUCCESS = 0,
        E_FAIL = -1,
        E_ERROR = -2
    };

    /*! Function is called by Ipc_attach() through NameServer_SetupProxy */
    @DirectCall
    Int attach(UInt16 remoteProcId, Ptr sharedAddr);

    /*! Function is called by Ipc_detach() through NameServer_SetupProxy */
    @DirectCall
    Int detach(UInt16 remoteProcId);

    /*!
     *  ======== sharedMemReq ========
     *  Returns the shared memory size requirement for a single instance
     *
     *  Function is called during Ipc_attach() through NameServer_SetupProxy.
     *
     *  @param(sharedAddr)   Shared address
     *
     *  @b(returns)          Number of MAUs needed to create the instance.
     */
    @DirectCall
    SizeT sharedMemReq(Ptr sharedAddr);

instance:

    /*!
     *  ======== create ========
     */
    override create(UInt16 procId);

    /*!
     *  ======== get ========
     */
    Int get(String instanceName,
            String name,
            Ptr value,
            UInt32 *valueLen,
            xdc.runtime.knl.ISync.Handle syncHandle,
            Error.Block *eb);
}