EndianHelper.hxx File Reference

#include "endian.h"
#include "openlcb/Defs.hxx"

Go to the source code of this file.

Namespaces
namespace	openlcb

Functions
NodeID	openlcb::NetworkToNodeID (const uint8_t *data)
	Takes six bytes (big-endian) from *data, and returns the node ID they represent.
void	openlcb::NodeIDToNetwork (const NodeID id, uint8_t *dst)
	Takes a node id from.
uint64_t	openlcb::NetworkToEventID (const void *data)
	Takes 8 bytes (big-endian) from *data, and returns the event id they represent.
void	openlcb::EventIDToNetwork (const uint64_t event_id, void *dst)
	Takes an event id from id, and copies it network-endian into *data.
string	openlcb::EventIDToPayload (const uint64_t event_id)
	Takes an event ID and returns a network encoding of it in a payload buffer.

Detailed Description

Copyright

Copyright (c) 2014, Balazs Racz 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.

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 HOLDER 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.

Helper functions for dealing with network byte order and NMRAnet identifiers.

Author

Balazs Racz

Date

6 Mar 2014

Definition in file EndianHelper.hxx.