Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

mib_common.h File Reference
Data Structures | Typedefs | Enumerations | Functions

mib_common.h File Reference

Common definitions for MIB modules. More...

Go to the source code of this file.

Data Structures

struct  _MibObject
 MIB object descriptor. More...
struct  MibModule
 MIB module. More...

Typedefs

typedef error_t(* MibSetValue )(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen)
 Set object value.
typedef error_t(* MibGetValue )(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
 Get object value.
typedef error_t(* MibGetNext )(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
 Get next object.
typedef error_t(* MibInit )(void)
 MIB initialization.
typedef void(* MibLock )(void)
 Lock MIB.
typedef void(* MibUnlock )(void)
 Unlock MIB.

Enumerations

enum  MibType
 

MIB object types.

More...
enum  MibAccess
 

Access modes.

More...

Functions

error_t mibEncodeIndex (uint8_t *oid, size_t maxOidLen, size_t *pos, uint_t index)
 Encode instance identifier (index)
error_t mibDecodeIndex (const uint8_t *oid, size_t oidLen, size_t *pos, uint_t *index)
 Decode instance identifier (index)
error_t mibEncodeIpv4Addr (uint8_t *oid, size_t maxOidLen, size_t *pos, Ipv4Addr ipAddr)
 Encode instance identifier (IPv4 address)
error_t mibDecodeIpv4Addr (const uint8_t *oid, size_t oidLen, size_t *pos, Ipv4Addr *ipAddr)
 Decode instance identifier (IPv4 address)
error_t mibEncodePort (uint8_t *oid, size_t maxOidLen, size_t *pos, uint16_t port)
 Encode instance identifier (port number)
error_t mibDecodePort (const uint8_t *oid, size_t oidLen, size_t *pos, uint16_t *port)
 Decode instance identifier (port number)

Detailed Description

Common definitions for MIB modules.

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file mib_common.h.

Typedef Documentation

typedef error_t(* MibGetNext)(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)

Get next object.

Definition at line 128 of file mib_common.h.

typedef error_t(* MibGetValue)(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)

Get object value.

Definition at line 120 of file mib_common.h.

typedef error_t(* MibInit)(void)

MIB initialization.

Definition at line 157 of file mib_common.h.

typedef void(* MibLock)(void)

Lock MIB.

Definition at line 164 of file mib_common.h.

typedef error_t(* MibSetValue)(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen)

Set object value.

Definition at line 112 of file mib_common.h.

typedef void(* MibUnlock)(void)

Unlock MIB.

Definition at line 171 of file mib_common.h.

Enumeration Type Documentation

enum MibAccess

Access modes.

Definition at line 67 of file mib_common.h.

enum MibType

MIB object types.

Definition at line 51 of file mib_common.h.

Function Documentation

error_t mibDecodeIndex ( const uint8_t *  oid,
size_t  oidLen,
size_t *  pos,
uint_t *  index 
)

Decode instance identifier (index)

Parameters:
[in]oidPointer to the object identifier
[in]oidLenLength of the OID, in bytes
[in,out]posOffset where to read the instance identifier
[out]indexIndex value
Returns:
Error code

Definition at line 61 of file mib_common.c.

error_t mibDecodeIpv4Addr ( const uint8_t *  oid,
size_t  oidLen,
size_t *  pos,
Ipv4Addr *  ipAddr 
)

Decode instance identifier (IPv4 address)

Parameters:
[in]oidPointer to the object identifier
[in]oidLenLength of the OID, in bytes
[in,out]posOffset where to read the instance identifier
[out]ipAddrIPv4 address
Returns:
Error code

Definition at line 122 of file mib_common.c.

error_t mibDecodePort ( const uint8_t *  oid,
size_t  oidLen,
size_t *  pos,
uint16_t *  port 
)

Decode instance identifier (port number)

Parameters:
[in]oidPointer to the object identifier
[in]oidLenLength of the OID, in bytes
[in,out]posOffset where to read the instance identifier
[out]portPort number
Returns:
Error code

Definition at line 179 of file mib_common.c.

error_t mibEncodeIndex ( uint8_t *  oid,
size_t  maxOidLen,
size_t *  pos,
uint_t  index 
)

Encode instance identifier (index)

Parameters:
[in]oidPointer to the object identifier
[in]maxOidLenMaximum number of bytes the OID can hold
[in,out]posOffset where to write the instance identifier
[in]indexIndex value
Returns:
Error code

Definition at line 45 of file mib_common.c.

error_t mibEncodeIpv4Addr ( uint8_t *  oid,
size_t  maxOidLen,
size_t *  pos,
Ipv4Addr  ipAddr 
)

Encode instance identifier (IPv4 address)

Parameters:
[in]oidPointer to the object identifier
[in]maxOidLenMaximum number of bytes the OID can hold
[in,out]posOffset where to write the instance identifier
[in]ipAddrIPv4 address
Returns:
Error code

Definition at line 89 of file mib_common.c.

error_t mibEncodePort ( uint8_t *  oid,
size_t  maxOidLen,
size_t *  pos,
uint16_t  port 
)

Encode instance identifier (port number)

Parameters:
[in]oidPointer to the object identifier
[in]maxOidLenMaximum number of bytes the OID can hold
[in,out]posOffset where to write the instance identifier
[in]portPort number
Returns:
Error code

Definition at line 163 of file mib_common.c.

Generated on Tue Jul 12 2022 17:10:21 by  doxygen 1.7.2