nbns_common.c File Reference

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

#include "core/net.h"
#include "netbios/nbns_client.h"
#include "netbios/nbns_responder.h"
#include "netbios/nbns_common.h"
#include "dns/dns_debug.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   NBNS_TRACE_LEVEL

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

Copyright (C) 2010-2024 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

2.4.0

Definition in file nbns_common.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   NBNS_TRACE_LEVEL

Definition at line 32 of file nbns_common.c.

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 286 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 150 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 53 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 202 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 80 of file nbns_common.c.