NameServer.h

Go to the documentation of this file.

/*
 * 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.
 */
#ifndef ti_ipc_NameServer__include
#define ti_ipc_NameServer__include

#if defined (__cplusplus)
extern "C" {
#endif

/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */

#define NameServer_S_BUSY                2

#define NameServer_S_ALREADYSETUP        1

#define NameServer_S_SUCCESS             0

#define NameServer_E_FAIL               -1

#define NameServer_E_INVALIDARG         -2

#define NameServer_E_MEMORY             -3

#define NameServer_E_ALREADYEXISTS      -4

#define NameServer_E_NOTFOUND           -5

#define NameServer_E_TIMEOUT            -6

#define NameServer_E_INVALIDSTATE       -7

#define NameServer_E_OSFAILURE          -8

#define NameServer_E_RESOURCE           -9

#define NameServer_E_RESTART            -10

/* =============================================================================
 *  Macros
 * =============================================================================
 */

#define NameServer_ALLOWGROWTH          (~0)

#define NameServer_Params_MAXNAMELEN    16

/* =============================================================================
 *  Structures & Enums
 * =============================================================================
 */

typedef struct NameServer_Object *NameServer_Handle;

typedef struct NameServer_Params {
    UInt maxRuntimeEntries;
    Ptr  tableHeap;
    Bool checkExisting;
    UInt maxValueLen;
    UInt maxNameLen;
} NameServer_Params;


/* =============================================================================
 *  NameServer Module-wide Functions
 * =============================================================================
 */

Void NameServer_Params_init(NameServer_Params *params);

NameServer_Handle NameServer_create(String name,
                                    const NameServer_Params *params);

Int NameServer_delete(NameServer_Handle *handlePtr);

NameServer_Handle NameServer_getHandle(String name);

/* =============================================================================
 *  NameServer Per-instance Functions
 * =============================================================================
 */

Ptr NameServer_add(NameServer_Handle handle, String name, Ptr buf, UInt32 len);

Ptr NameServer_addUInt32(NameServer_Handle handle, String name, UInt32 value);

Int NameServer_get(NameServer_Handle handle,
                   String name,
                   Ptr buf,
                   UInt32 *len,
                   UInt16 procId[]);

Int NameServer_getUInt32(NameServer_Handle handle,
                         String name,
                         Ptr buf,
                         UInt16 procId[]);

Int NameServer_getLocal(NameServer_Handle handle,
                        String name,
                        Ptr buf,
                        UInt32 *len);

Int NameServer_getLocalUInt32(NameServer_Handle handle,
                              String name,
                              Ptr buf);

Int NameServer_match(NameServer_Handle handle, String name, UInt32 *value);

Int NameServer_remove(NameServer_Handle handle, String name);

Int NameServer_removeEntry(NameServer_Handle handle, Ptr entry);

#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */

#endif /* ti_ipc_NameServer__include */