Link communication module

Contents

Multiplayer communication through a link cable, provided by gba-link-connection.

Keep in mind that some messages will be lost between players.

Files

file bn_config_link.h
file bn_link.h
file bn_link_baud_rate.h
file bn_link_player.h
file bn_link_state.h

Namespaces

namespace bn
Main Butano namespace.
namespace bn::link
Link communication related functions.

Classes

class bn::link_player
Contains the data of a message provided by a player.
class bn::link_state
Stores the state of a communication through the link cable.

Defines

#define BN_CFG_LINK_BAUD_RATE
#define BN_CFG_LINK_SEND_WAIT
#define BN_CFG_LINK_MAX_MESSAGES
#define BN_CFG_LINK_MAX_MISSING_MESSAGES
#define BN_LINK_BAUD_RATE_9600_BPS
#define BN_LINK_BAUD_RATE_38400_BPS
#define BN_LINK_BAUD_RATE_57600_BPS
#define BN_LINK_BAUD_RATE_115200_BPS

Define documentation

#define BN_CFG_LINK_BAUD_RATE

Specifies transmission rate in bps.

Values not specified in BN_LINK_BAUD_RATE_* macros are not allowed.

#define BN_CFG_LINK_SEND_WAIT

Specifies how much time the GBA has to wait before sending pending messages.

If this parameter is too low, some messages will be lost, but if it is too high, CPU usage will increase a lot.

#define BN_CFG_LINK_MAX_MESSAGES

Specifies the maximum number of stored messages for each player.

#define BN_CFG_LINK_MAX_MISSING_MESSAGES

Specifies the maximum number of missing messages before resetting the communication.