Definitions common to NBNS client and NBNS responder. More...

#include "core/net.h"
#include "dns/dns_common.h"

Macros
#define	NBNS_DEFAULT_RESOURCE_RECORD_TTL 120

#define	NBNS_PORT 137

#define	NBNS_ENCODE_H(c) ('A' + (((c) >> 4) & 0x0F))

#define	NBNS_ENCODE_L(c) ('A' + ((c) & 0x0F))

Typedefs
struct {
uint16_t id

uint8_t rd: 1

uint8_t tc: 1

uint8_t aa: 1

uint8_t opcode: 4

uint8_t qr: 1

uint8_t rcode: 4

uint8_t b: 1

uint8_t z: 2

uint8_t ra: 1

uint16_t qdcount

uint16_t ancount

uint16_t nscount

uint16_t arcount

uint8_t questions []

}	NbnsHeader
	NBNS message header. More...

struct {
uint16_t flags

Ipv4Addr addr

}	NbnsAddrEntry
	NBNS address entry. More...

Enumerations
enum	DnsFlags { NBNS_ONT_BNODE = 0x0000 , NBNS_ONT_PNODE = 0x2000 , NBNS_ONT_MNODE = 0x4000 , NBNS_G_UNIQUE = 0x0000 , NBNS_G_GROUP = 0x8000 }
	NBNS flags. More...

Functions
error_t	nbnsInit (NetInterface *interface)
	NBNS related initialization. More...

void	nbnsProcessMessage (NetInterface interface, const IpPseudoHeader pseudoHeader, const UdpHeader udpHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary, void param)
	Process incoming NBNS message. More...

size_t	nbnsEncodeName (const char_t src, uint8_t dest)
	Encode a NetBIOS name. More...

size_t	nbnsParseName (const NbnsHeader message, size_t length, size_t pos, char_t dest)
	Decode a NetBIOS name. More...

bool_t	nbnsCompareName (const NbnsHeader message, size_t length, size_t pos, const char_t name)
	Compare NetBIOS names. More...

Detailed Description

Definitions common to NBNS client and NBNS responder.

License

SPDX-License-Identifier: GPL-2.0-or-later

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: 2.1.4

Definition in file nbns_common.h.

Macro Definition Documentation

◆ NBNS_DEFAULT_RESOURCE_RECORD_TTL

#define NBNS_DEFAULT_RESOURCE_RECORD_TTL 120

Definition at line 40 of file nbns_common.h.

◆ NBNS_ENCODE_H

#define NBNS_ENCODE_H ( c ) ('A' + (((c) >> 4) & 0x0F))

Definition at line 49 of file nbns_common.h.

◆ NBNS_ENCODE_L

#define NBNS_ENCODE_L ( c ) ('A' + ((c) & 0x0F))

Definition at line 50 of file nbns_common.h.

◆ NBNS_PORT

#define NBNS_PORT 137

Definition at line 46 of file nbns_common.h.

Typedef Documentation

◆

typedef { ... } NbnsAddrEntry

NBNS address entry.

◆

typedef { ... } NbnsHeader

NBNS message header.

Enumeration Type Documentation

◆ DnsFlags

enum DnsFlags

NBNS flags.

Enumerator
NBNS_ONT_BNODE
NBNS_ONT_PNODE
NBNS_ONT_MNODE
NBNS_G_UNIQUE
NBNS_G_GROUP

Definition at line 62 of file nbns_common.h.

Function Documentation

◆ nbnsCompareName()

bool_t nbnsCompareName	(	const NbnsHeader *	message,
		size_t	length,
		size_t	pos,
		const char_t *	name
	)

Compare NetBIOS names.

Parameters

[in]	message	Pointer to the NBNS message
[in]	length	Length of the NBNS message
[in]	pos	Offset of the encoded domain name
[in]	name	NULL-terminated string that holds a domain name

Returns: TRUE if the NetBIOS names match, else FALSE

Definition at line 289 of file nbns_common.c.

◆ nbnsEncodeName()

size_t nbnsEncodeName	(	const char_t *	src,
		uint8_t *	dest
	)

Encode a NetBIOS name.

Parameters

[in]	src	Pointer to the name to encode
[out]	dest	Pointer to the encoded NetBIOS name

Returns: Length of the encoded NetBIOS name

Definition at line 153 of file nbns_common.c.

◆ nbnsInit()

error_t nbnsInit ( NetInterface * interface )

NBNS related initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 56 of file nbns_common.c.

◆ nbnsParseName()

size_t nbnsParseName	(	const NbnsHeader *	message,
		size_t	length,
		size_t	pos,
		char_t *	dest
	)

Decode a NetBIOS name.

Parameters

[in]	message	Pointer to the NBNS message
[in]	length	Length of the NBNS message
[in]	pos	Offset of the name to decode
[out]	dest	Pointer to the decoded name (optional)

Returns: The position of the resource record that immediately follows the NetBIOS name

Definition at line 205 of file nbns_common.c.

◆ nbnsProcessMessage()

void nbnsProcessMessage	(	NetInterface *	interface,
		const IpPseudoHeader *	pseudoHeader,
		const UdpHeader *	udpHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary,
		void *	param
	)

Process incoming NBNS message.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	UDP pseudo header
[in]	udpHeader	UDP header
[in]	buffer	Multi-part buffer containing the incoming NBNS message
[in]	offset	Offset to the first byte of the NBNS message
[in]	ancillary	Additional options passed to the stack along with the packet
[in]	param	Callback function parameter (not used)

Definition at line 83 of file nbns_common.c.

Variable Documentation

◆ aa

uint8_t aa

Definition at line 98 of file nbns_common.h.

◆ addr

Ipv4Addr addr

Definition at line 121 of file nbns_common.h.

◆ ancount

uint16_t ancount

Definition at line 107 of file nbns_common.h.

◆ arcount

uint16_t arcount

Definition at line 109 of file nbns_common.h.

◆ b

uint8_t b

Definition at line 102 of file nbns_common.h.

◆ flags

uint16_t flags

Definition at line 120 of file nbns_common.h.

◆ id

uint16_t id

Definition at line 84 of file nbns_common.h.

◆ nscount

uint16_t nscount

Definition at line 108 of file nbns_common.h.

◆ opcode

uint8_t opcode

Definition at line 99 of file nbns_common.h.

◆ qdcount

uint16_t qdcount

Definition at line 106 of file nbns_common.h.

◆ qr

uint8_t qr

Definition at line 100 of file nbns_common.h.

◆ questions

uint8_t questions[]

Definition at line 110 of file nbns_common.h.

◆ ra

uint8_t ra

Definition at line 104 of file nbns_common.h.

◆ rcode

uint8_t rcode

Definition at line 101 of file nbns_common.h.

◆ rd

uint8_t rd

Definition at line 96 of file nbns_common.h.

◆ tc

uint8_t tc

Definition at line 97 of file nbns_common.h.

◆ z

uint8_t z

Definition at line 103 of file nbns_common.h.

Macros

Typedefs

Enumerations

Functions

Detailed Description

License

Macro Definition Documentation

◆ NBNS_DEFAULT_RESOURCE_RECORD_TTL

◆ NBNS_ENCODE_H

◆ NBNS_ENCODE_L

◆ NBNS_PORT

Typedef Documentation

◆

◆

Enumeration Type Documentation

◆ DnsFlags

Function Documentation

◆ nbnsCompareName()

◆ nbnsEncodeName()

◆ nbnsInit()

◆ nbnsParseName()

◆ nbnsProcessMessage()

Variable Documentation

◆ aa

◆ addr

◆ ancount

◆ arcount

◆ b

◆ flags

◆ id

◆ nscount

◆ opcode

◆ qdcount

◆ qr

◆ questions

◆ ra

◆ rcode

◆ rd

◆ tc

◆ z