Move network code into its own dusknetwork module, gate behind DUSK_NETWORK
Splits the platform-agnostic network core out of dusk into a top-level dusknetwork module, mirroring the duskgl/dusksdl2 pattern. Adds a DUSK_NETWORK cmake option (default ON) so builds can exclude all networking code, including the per-platform implementations. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
# Copyright (c) 2026 Dominic Masters
|
||||
#
|
||||
# This software is released under the MIT License.
|
||||
# https://opensource.org/licenses/MIT
|
||||
|
||||
# Includes
|
||||
target_include_directories(${DUSK_LIBRARY_TARGET_NAME}
|
||||
PUBLIC
|
||||
${CMAKE_CURRENT_LIST_DIR}
|
||||
)
|
||||
|
||||
# Subdirs
|
||||
add_subdirectory(network)
|
||||
@@ -0,0 +1,10 @@
|
||||
# Copyright (c) 2026 Dominic Masters
|
||||
#
|
||||
# This software is released under the MIT License.
|
||||
# https://opensource.org/licenses/MIT
|
||||
|
||||
target_sources(${DUSK_LIBRARY_TARGET_NAME}
|
||||
PUBLIC
|
||||
network.c
|
||||
networkinfo.c
|
||||
)
|
||||
@@ -0,0 +1,116 @@
|
||||
/**
|
||||
* Copyright (c) 2026 Dominic Masters
|
||||
*
|
||||
* This software is released under the MIT License.
|
||||
* https://opensource.org/licenses/MIT
|
||||
*/
|
||||
|
||||
#include "network.h"
|
||||
#include "util/memory.h"
|
||||
#include "assert/assert.h"
|
||||
#include "log/log.h"
|
||||
|
||||
network_t NETWORK;
|
||||
|
||||
errorret_t networkInit() {
|
||||
memoryZero(&NETWORK, sizeof(network_t));
|
||||
|
||||
NETWORK.errorState.code = ERROR_OK;
|
||||
NETWORK.onDisconnect = NULL;
|
||||
|
||||
return networkPlatformInit();
|
||||
}
|
||||
|
||||
errorret_t networkUpdate() {
|
||||
errorChain(networkPlatformUpdate());
|
||||
|
||||
if(NETWORK.state == NETWORK_STATE_CONNECTED && !networkIsConnected()) {
|
||||
NETWORK.state = NETWORK_STATE_DISCONNECTED;
|
||||
|
||||
if(NETWORK.onDisconnect) {
|
||||
errorret_t ret;
|
||||
if(NETWORK.errorState.code == ERROR_OK) {
|
||||
ret = errorThrowImpl(
|
||||
&NETWORK.errorState,
|
||||
ERROR_NOT_OK,
|
||||
__FILE__, __func__, __LINE__,
|
||||
"Network connection lost"
|
||||
);
|
||||
} else {
|
||||
ret.code = NETWORK.errorState.code;
|
||||
ret.state = &NETWORK.errorState;
|
||||
}
|
||||
NETWORK.onDisconnect(ret, NETWORK.disconnectUser);
|
||||
}
|
||||
}
|
||||
|
||||
errorOk();
|
||||
}
|
||||
|
||||
bool_t networkIsConnected() {
|
||||
return networkPlatformIsConnected();
|
||||
}
|
||||
|
||||
void networkRequestConnection(
|
||||
void (*onConnected)(void *user),
|
||||
void (*onFailed)(errorret_t error, void *user),
|
||||
void (*onDisconnect)(errorret_t error, void *user),
|
||||
void *user
|
||||
) {
|
||||
assertNotNull(onConnected, "onConnected callback must not be null");
|
||||
assertNotNull(onFailed, "onFailed callback must not be null");
|
||||
assertNotNull(onDisconnect, "onDisconnect callback must not be null");
|
||||
|
||||
NETWORK.state = NETWORK_STATE_CONNECTING;
|
||||
NETWORK.onDisconnect = onDisconnect;
|
||||
NETWORK.disconnectUser = user;
|
||||
|
||||
#ifndef networkPlatformRequestConnection
|
||||
// This is a platform cannot be requested to go online, this would basically
|
||||
// be for platforms like Linux or Windows where the OS is responsible for
|
||||
// maintaining the network connection.
|
||||
|
||||
if(networkIsConnected()) {
|
||||
NETWORK.state = NETWORK_STATE_CONNECTED;
|
||||
onConnected(user);
|
||||
} else {
|
||||
errorret_t ret = errorThrowImpl(
|
||||
&NETWORK.errorState,
|
||||
ERROR_NOT_OK,
|
||||
__FILE__, __func__, __LINE__,
|
||||
"No network connection available"
|
||||
);
|
||||
onFailed(ret, user);
|
||||
}
|
||||
#else
|
||||
networkPlatformRequestConnection(onConnected, onFailed, onDisconnect, user);
|
||||
#endif
|
||||
}
|
||||
|
||||
void networkRequestDisconnection(
|
||||
void (*onComplete)(void *user),
|
||||
void *user
|
||||
) {
|
||||
assertNotNull(onComplete, "onComplete callback must not be null");
|
||||
NETWORK.state = NETWORK_STATE_DISCONNECTING;
|
||||
|
||||
#ifndef networkPlatformRequestDisconnection
|
||||
NETWORK.state = NETWORK_STATE_DISCONNECTED;
|
||||
onComplete(user);
|
||||
#else
|
||||
networkPlatformRequestDisconnection(onComplete, user);
|
||||
#endif
|
||||
}
|
||||
|
||||
void networkDisconnectedDuringDispose(void *u) {
|
||||
logDebug("Network disconnected during dispose\n");
|
||||
}
|
||||
|
||||
errorret_t networkDispose() {
|
||||
if(NETWORK.state == NETWORK_STATE_CONNECTED) {
|
||||
networkRequestDisconnection(networkDisconnectedDuringDispose, NULL);
|
||||
}
|
||||
|
||||
errorChain(networkPlatformDispose());
|
||||
errorOk();
|
||||
}
|
||||
@@ -0,0 +1,126 @@
|
||||
/**
|
||||
* Copyright (c) 2026 Dominic Masters
|
||||
*
|
||||
* This software is released under the MIT License.
|
||||
* https://opensource.org/licenses/MIT
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "error/error.h"
|
||||
#include "network/networkplatform.h"
|
||||
#ifndef networkPlatformInit
|
||||
#error "networkPlatformInit must be defined"
|
||||
#endif
|
||||
#ifndef networkPlatformUpdate
|
||||
#error "networkPlatformUpdate must be defined"
|
||||
#endif
|
||||
#ifndef networkPlatformDispose
|
||||
#error "networkPlatformDispose must be defined"
|
||||
#endif
|
||||
#ifndef networkPlatformIsConnected
|
||||
#error "networkPlatformIsConnected must be defined"
|
||||
#endif
|
||||
|
||||
typedef enum {
|
||||
NETWORK_STATE_DISCONNECTED,
|
||||
NETWORK_STATE_CONNECTING,
|
||||
NETWORK_STATE_CONNECTED,
|
||||
NETWORK_STATE_DISCONNECTING,
|
||||
} networkstate_t;
|
||||
|
||||
typedef struct {
|
||||
networkplatform_t platform;
|
||||
errorstate_t errorState;
|
||||
networkstate_t state;
|
||||
|
||||
void (*onDisconnect)(errorret_t error, void *user);
|
||||
void *disconnectUser;
|
||||
} network_t;
|
||||
|
||||
extern network_t NETWORK;
|
||||
|
||||
/**
|
||||
* Initializes the network system. This will NOT connect to the network.
|
||||
*
|
||||
* @return An error code indicating success or failure.
|
||||
*/
|
||||
errorret_t networkInit();
|
||||
|
||||
/**
|
||||
* Updates the network manager, dispatching any completed async request
|
||||
* callbacks on the main thread.
|
||||
*
|
||||
* @return An error code indicating success or failure.
|
||||
*/
|
||||
errorret_t networkUpdate();
|
||||
|
||||
/**
|
||||
* Disposes of the network manager. This will NOT disconnect from the network.
|
||||
*
|
||||
* @return An error code indicating success or failure.
|
||||
*/
|
||||
errorret_t networkDispose();
|
||||
|
||||
/**
|
||||
* Returns true if the system is connected to AN network, this doesn't mean that
|
||||
* requests will succeed, doesn't mean there's internet, just that we could
|
||||
* possibly make network requests. If this is false, this usually means
|
||||
* something like;
|
||||
* - A network cable is not connnected
|
||||
* - No Wi-Fi Connection has been established
|
||||
* - No IP Address has been assigned
|
||||
*
|
||||
* That kinda stuff.
|
||||
*
|
||||
* In future I will probably have REASONS for why it's not connected, for
|
||||
* example;
|
||||
* - On PSP you need to "request" network access
|
||||
* - On GameCube, network settings need to be defined, including DHCP, etc.
|
||||
* - On Windows, this may require additional permissions
|
||||
*
|
||||
* @return True if some network connection is detected.
|
||||
*/
|
||||
bool_t networkIsConnected();
|
||||
|
||||
/**
|
||||
* See networkIsConnected for a bit more info, but this is for some
|
||||
* platforms (mainly PSP) to request the system to start doing networking.
|
||||
*
|
||||
* You should only call this once and assume that it is "pending" until either
|
||||
* onComplete or onFailed is invoked. If you call this twice it is undefined
|
||||
* behavior.
|
||||
*
|
||||
* onDisconnect must be provided, and is called whenever the network is lost
|
||||
* after a successful connection. This will NOT be called if disconnect is
|
||||
* manually triggered, but WILL if an error occurs, or a network stack bug, etc.
|
||||
*
|
||||
* @param onConnected Callback to invoke when the network is connected.
|
||||
* @param onFailed Callback to invoke if the network connection fails.
|
||||
* @param onDisconnect Called after a successful connection, when disconnected.
|
||||
* @param user User data to pass to the callbacks.
|
||||
*/
|
||||
void networkRequestConnection(
|
||||
void (*onConnected)(void *user),
|
||||
void (*onFailed)(errorret_t error, void *user),
|
||||
void (*onDisconnect)(errorret_t error, void *user),
|
||||
void *user
|
||||
);
|
||||
|
||||
/**
|
||||
* Requests the system to disconnect from the network. This is basically just
|
||||
* for PSP, but I guess it could be used on other platforms in future if they
|
||||
* have some kind of "network connection mode" that needs to be exited.
|
||||
*
|
||||
* You should only call this once and assume that it is "pending" until
|
||||
* onComplete is invoked. If you call this twice it is undefined behavior.
|
||||
*
|
||||
* If it fails, you still get onComplete called, but may fail if you try to
|
||||
* reconnect later unfortunately.
|
||||
*
|
||||
* @param onComplete Callback to invoke when the network is disconnected.
|
||||
* @param user User data to pass to the callback.
|
||||
*/
|
||||
void networkRequestDisconnection(
|
||||
void (*onComplete)(void *user),
|
||||
void *user
|
||||
);
|
||||
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* Copyright (c) 2026 Dominic Masters
|
||||
*
|
||||
* This software is released under the MIT License.
|
||||
* https://opensource.org/licenses/MIT
|
||||
*/
|
||||
|
||||
#include "network.h"
|
||||
#include "networkinfo.h"
|
||||
#include "network/networkplatform.h"
|
||||
#include "assert/assert.h"
|
||||
|
||||
#ifndef networkPlatformGetInfo
|
||||
#error "networkPlatformGetInfo must be defined"
|
||||
#endif
|
||||
|
||||
networkinfo_t networkGetInfo() {
|
||||
assertTrue(
|
||||
NETWORK.state == NETWORK_STATE_CONNECTED,
|
||||
"networkGetInfo called when not connected"
|
||||
);
|
||||
|
||||
return networkPlatformGetInfo();
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
/**
|
||||
* Copyright (c) 2026 Dominic Masters
|
||||
*
|
||||
* This software is released under the MIT License.
|
||||
* https://opensource.org/licenses/MIT
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "dusk.h"
|
||||
|
||||
#define NETWORK_INFO_IPV4_DNS_COUNT_MAX 2
|
||||
#define NETWORK_INFO_IPV4_OCTET_COUNT 4
|
||||
#define NETWORK_INFO_IPV6_OCTET_COUNT 16
|
||||
#define NETWORK_INFO_IPV6_DNS_COUNT_MAX 2
|
||||
#define NETWORK_INFO_FORMAT_IPV4 "%u.%u.%u.%u"
|
||||
#define NETWORK_INFO_FORMAT_IPV6 \
|
||||
"%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x"
|
||||
|
||||
typedef enum {
|
||||
NETWORK_TYPE_IPV4,
|
||||
#ifdef DUSK_NETWORK_IPV6
|
||||
NETWORK_TYPE_IPV6,
|
||||
#endif
|
||||
} networktype_t;
|
||||
|
||||
typedef struct {
|
||||
uint8_t ip[NETWORK_INFO_IPV4_OCTET_COUNT];
|
||||
} networkinfoipv4_t;
|
||||
|
||||
#ifdef DUSK_NETWORK_IPV6
|
||||
typedef struct {
|
||||
uint8_t ip[NETWORK_INFO_IPV6_OCTET_COUNT];
|
||||
} networkinfoipv6_t;
|
||||
#endif
|
||||
|
||||
typedef struct {
|
||||
networktype_t type;
|
||||
union {
|
||||
networkinfoipv4_t ipv4;
|
||||
#ifdef DUSK_NETWORK_IPV6
|
||||
networkinfoipv6_t ipv6;
|
||||
#endif
|
||||
};
|
||||
} networkinfo_t;
|
||||
|
||||
/**
|
||||
* Returns the network information for the currently active network connection.
|
||||
*
|
||||
* @return Network information for the currently active network connection.
|
||||
*/
|
||||
networkinfo_t networkGetInfo();
|
||||
Reference in New Issue
Block a user