Banjo API 1.1.0-alpha
Low-level C99 game development API
Loading...
Searching...
No Matches
net.h
Go to the documentation of this file.
1
68#ifndef BJ_NET_H
69#define BJ_NET_H
70
71#include <banjo/api.h>
72#include <banjo/error.h>
73
81struct bj_address;
82
89struct bj_tcp_listener;
90
97struct bj_tcp_stream;
98
104struct bj_udp;
105
112struct bj_datagram;
113
128
130#define BJ_NET_NOHINT BJ_NET_HINT_NONE
132#define BJ_RESOLVE_IPV4 BJ_NET_HINT_IPV4
134#define BJ_RESOLVE_IPV6 BJ_NET_HINT_IPV6
136#define BJ_EXCLUSIVE_BIND BJ_NET_HINT_EXCLUSIVE_BIND
138#define BJ_TCP_DELAY_ACK BJ_NET_HINT_DELAY_ACK
140#define BJ_NONBLOCKING BJ_NET_HINT_NONBLOCKING
142#define BJ_BROADCAST BJ_NET_HINT_BROADCAST
143
148
170 const char* host,
171 uint16_t port,
172 uint16_t hints,
173 struct bj_error** error
174);
175
186 const struct bj_address* addr,
187 char* buf,
188 size_t size
189);
190
198BANJO_EXPORT uint16_t bj_address_port(const struct bj_address* addr);
199
210 const struct bj_address* a,
211 const struct bj_address* b
212);
213
223BANJO_EXPORT size_t bj_address_count(const struct bj_address* addr);
224
236
243
250
252
261
263#define BJ_SHUTDOWN_RECEIVE BJ_NET_SHUTDOWN_RECEIVE
265#define BJ_SHUTDOWN_SEND BJ_NET_SHUTDOWN_SEND
267#define BJ_SHUTDOWN_BOTH BJ_NET_SHUTDOWN_BOTH
268
275#define BJ_ADDR_STRLEN 46
276
282#define BJ_NET_BACKLOG_DEFAULT 0
283
289#define BJ_NET_BACKLOG_MAX (-1)
290
315 const char* host,
316 uint16_t port,
317 uint16_t hint,
318 int backlog,
319 struct bj_error** error
320);
321
346 const char* host,
347 uint16_t port,
348 uint16_t hint,
349 uint32_t ms_timeout,
350 struct bj_error** error
351);
352
371 struct bj_address* addr,
372 uint16_t hints,
373 uint32_t ms_timeout,
374 struct bj_error** error
375);
376
394 struct bj_tcp_listener* listener,
395 uint32_t ms_timeout,
396 struct bj_error** error
397);
398
415 struct bj_tcp_stream* stream,
416 void* buf,
417 size_t len
418);
419
436 struct bj_tcp_stream* stream,
437 void* buf,
438 size_t len
439);
440
454 struct bj_tcp_stream* stream,
455 const void* buf,
456 size_t len
457);
458
472 struct bj_tcp_stream* stream,
473 int mode
474);
475
489
499
508
521 struct bj_tcp_stream* stream,
522 uint32_t ms_timeout
523);
524
536 struct bj_tcp_stream* stream,
537 uint32_t ms_timeout
538);
539
548
560 struct bj_tcp_stream* stream,
561 uint32_t ms_timeout
562);
563
572
573struct bj_stream;
574
602 struct bj_tcp_stream* tcp,
603 uint32_t flags
604);
605
614 struct bj_tcp_stream* stream
615);
616
625 struct bj_tcp_listener* listener
626);
627
646 const struct bj_tcp_stream* stream,
647 char* buf,
648 size_t size
649);
650
669 const struct bj_tcp_stream* stream,
670 char* buf,
671 size_t size
672);
673
684 const struct bj_tcp_listener* listener
685);
686
694 struct bj_tcp_stream* stream
695);
696
701
715 const char* host,
716 uint16_t port,
717 uint16_t hints,
718 struct bj_error** error
719);
720
727 struct bj_udp* udp
728);
729
748 struct bj_udp* udp,
749 const char* host,
750 uint16_t port,
751 const void* data,
752 size_t len,
753 struct bj_error** error
754);
755
776 struct bj_udp* udp,
777 const struct bj_address* addr,
778 const void* data,
779 size_t len,
780 struct bj_error** error
781);
782
795 struct bj_udp* udp,
796 struct bj_error** error
797);
798
806 struct bj_udp* udp
807);
808
819 struct bj_udp* udp,
820 uint32_t ms_timeout
821);
822
830 const struct bj_udp* udp
831);
832
842 const struct bj_udp* udp,
843 char* buf,
844 size_t size
845);
846
848
853
863 const struct bj_datagram* dgram,
864 char* buf,
865 size_t size
866);
867
875 const struct bj_datagram* dgram
876);
877
885 const struct bj_datagram* dgram
886);
887
895 const struct bj_datagram* dgram
896);
897
904 struct bj_datagram* dgram
905);
906
908
909// --- Deprecated names (renamed on the road to 2.0) --------------------------
910
912BANJO_EXPORT size_t bj_address_string(const struct bj_address* addr, char* buf, size_t size);
916BANJO_EXPORT struct bj_tcp_listener* bj_listen_tcp(const char* host, uint16_t port,
917 uint16_t hint, int backlog,
918 struct bj_error** error);
920BANJO_EXPORT struct bj_tcp_stream* bj_connect_tcp(const char* host, uint16_t port,
921 uint16_t hint, uint32_t ms_timeout,
922 struct bj_error** error);
924BANJO_EXPORT struct bj_tcp_stream* bj_connect_tcp_to(struct bj_address* addr, uint16_t hints,
925 uint32_t ms_timeout, struct bj_error** error);
928 uint32_t ms_timeout, struct bj_error** error);
930BANJO_EXPORT int bj_tcp_recv(struct bj_tcp_stream* stream, void* buf, size_t len);
932BANJO_EXPORT int bj_tcp_peek(struct bj_tcp_stream* stream, void* buf, size_t len);
934BANJO_EXPORT int bj_tcp_send(struct bj_tcp_stream* stream, const void* buf, size_t len);
936BANJO_EXPORT void bj_tcp_shutdown(struct bj_tcp_stream* stream, int mode);
942BANJO_EXPORT bj_bool bj_tcp_wait(struct bj_tcp_stream* stream, uint32_t ms_timeout);
944BANJO_EXPORT bj_bool bj_set_tcp_recv_timeout(struct bj_tcp_stream* stream, uint32_t ms_timeout);
954BANJO_EXPORT struct bj_udp* bj_open_udp(const char* host, uint16_t port,
955 uint16_t hints, struct bj_error** error);
959BANJO_EXPORT int bj_udp_send(struct bj_udp* udp, const char* host, uint16_t port,
960 const void* data, size_t len, struct bj_error** error);
962BANJO_EXPORT int bj_udp_send_to(struct bj_udp* udp, const struct bj_address* addr,
963 const void* data, size_t len, struct bj_error** error);
965BANJO_EXPORT struct bj_datagram* bj_udp_recv(struct bj_udp* udp, struct bj_error** error);
969BANJO_EXPORT bj_bool bj_udp_wait(struct bj_udp* udp, uint32_t ms_timeout);
971BANJO_EXPORT size_t bj_datagram_addr(const struct bj_datagram* dgram, char* buf, size_t size);
973BANJO_EXPORT size_t bj_datagram_len(const struct bj_datagram* dgram);
976
977#endif
General-purpose definitions for Banjo API.
bj_audio_play_note_data data
Definition audio_pcm.c:104
Recoverable error handling.
struct bj_datagram bj_datagram
Definition api.h:346
struct bj_stream bj_stream
Definition api.h:374
struct bj_address bj_address
Definition api.h:335
struct bj_error bj_error
Definition api.h:348
#define BANJO_EXPORT
Definition api.h:179
struct bj_udp bj_udp
Definition api.h:379
uint32_t bj_bool
Boolean type used throughout the Banjo API.
Definition api.h:264
struct bj_tcp_listener bj_tcp_listener
Definition api.h:376
struct bj_tcp_stream bj_tcp_stream
Definition api.h:377
struct bj_address * bj_resolve_address(const char *host, uint16_t port, uint16_t hints, struct bj_error **error)
Resolves a hostname to a network address.
bj_bool bj_udp_has_data(struct bj_udp *udp)
Checks if a datagram is available without blocking.
struct bj_datagram * bj_receive_udp(struct bj_udp *udp, struct bj_error **error)
Receives a datagram from the UDP socket.
size_t bj_datagram_addr(const struct bj_datagram *dgram, char *buf, size_t size)
void bj_shutdown_tcp(struct bj_tcp_stream *stream, int mode)
Shuts down part or all of a TCP connection.
bj_bool bj_address_next(struct bj_address *addr)
Advances to the next resolved address.
bj_bool bj_address_equals(const struct bj_address *a, const struct bj_address *b)
Compares two addresses for equality.
bj_bool bj_wait_udp(struct bj_udp *udp, uint32_t ms_timeout)
Waits for data to become available on a UDP socket.
size_t bj_datagram_length(const struct bj_datagram *dgram)
Gets the data length from a datagram.
int bj_send_tcp(struct bj_tcp_stream *stream, const void *buf, size_t len)
Sends data over a TCP stream.
uint16_t bj_tcp_listener_port(const struct bj_tcp_listener *listener)
Get the listening port of the given server.
void bj_close_datagram(struct bj_datagram *dgram)
int bj_tcp_recv(struct bj_tcp_stream *stream, void *buf, size_t len)
uint32_t bj_get_tcp_recv_timeout(struct bj_tcp_stream *stream)
void bj_destroy_tcp_listener(struct bj_tcp_listener *listener)
Closes a TCP listener and releases associated resources.
struct bj_udp * bj_open_udp(const char *host, uint16_t port, uint16_t hints, struct bj_error **error)
size_t bj_tcp_peer_address(const struct bj_tcp_stream *stream, char *buf, size_t size)
Gets the remote address of a TCP stream.
uint16_t bj_datagram_port(const struct bj_datagram *dgram)
Gets the sender's port from a datagram.
void bj_destroy_datagram(struct bj_datagram *dgram)
Closes a datagram and frees resources.
size_t bj_datagram_len(const struct bj_datagram *dgram)
bj_bool bj_set_tcp_send_timeout(struct bj_tcp_stream *stream, uint32_t ms_timeout)
Sets the send timeout for a TCP stream.
uint32_t bj_tcp_receive_timeout(struct bj_tcp_stream *stream)
Gets the current receive timeout.
int bj_send_udp_to(struct bj_udp *udp, const struct bj_address *addr, const void *data, size_t len, struct bj_error **error)
Sends a datagram to a pre-resolved address (no DNS lookup).
struct bj_tcp_stream * bj_connect_tcp_to(struct bj_address *addr, uint16_t hints, uint32_t ms_timeout, struct bj_error **error)
bj_bool bj_set_tcp_keepalive(struct bj_tcp_stream *stream, bj_bool enable)
bj_bool bj_get_tcp_keepalive(struct bj_tcp_stream *stream)
size_t bj_tcp_local_address(const struct bj_tcp_stream *stream, char *buf, size_t size)
Gets the local address of a TCP stream.
bj_bool bj_set_tcp_recv_timeout(struct bj_tcp_stream *stream, uint32_t ms_timeout)
int bj_receive_tcp(struct bj_tcp_stream *stream, void *buf, size_t len)
Receives data from a TCP stream.
void bj_free_address(struct bj_address *addr)
void bj_close_tcp_stream(struct bj_tcp_stream *stream)
int bj_tcp_available(struct bj_tcp_stream *stream)
Checks bytes available to read without blocking.
size_t bj_address_count(const struct bj_address *addr)
Returns number of resolved addresses.
void bj_destroy_udp(struct bj_udp *udp)
Closes a UDP socket.
int bj_udp_send(struct bj_udp *udp, const char *host, uint16_t port, const void *data, size_t len, struct bj_error **error)
struct bj_udp * bj_create_udp(const char *host, uint16_t port, uint16_t hints, struct bj_error **error)
Opens a UDP socket bound to the specified port.
uint16_t bj_udp_local_port(const struct bj_udp *udp)
Gets the local port of a UDP socket.
size_t bj_address_string(const struct bj_address *addr, char *buf, size_t size)
bj_net_hint
Hint flags for network operations.
Definition net.h:119
int bj_tcp_peek(struct bj_tcp_stream *stream, void *buf, size_t len)
uint32_t bj_tcp_send_timeout(struct bj_tcp_stream *stream)
Gets the current send timeout.
int bj_peek_tcp(struct bj_tcp_stream *stream, void *buf, size_t len)
Peek at incoming data without consuming it.
void bj_destroy_address(struct bj_address *addr)
Frees a resolved address.
void bj_address_reset(struct bj_address *addr)
Resets address iteration to the first resolved address.
uint32_t bj_get_tcp_send_timeout(struct bj_tcp_stream *stream)
struct bj_tcp_stream * bj_connect_tcp_stream(const char *host, uint16_t port, uint16_t hint, uint32_t ms_timeout, struct bj_error **error)
Connects to a TCP server at the specified host and port.
bj_bool bj_enable_tcp_keepalive(struct bj_tcp_stream *stream)
Turns on TCP keep-alive probes for a stream.
bj_bool bj_wait_tcp(struct bj_tcp_stream *stream, uint32_t ms_timeout)
Waits for data to become available on a TCP stream.
void bj_tcp_shutdown(struct bj_tcp_stream *stream, int mode)
struct bj_tcp_stream * bj_connect_tcp_stream_to(struct bj_address *addr, uint16_t hints, uint32_t ms_timeout, struct bj_error **error)
Connects to a pre-resolved address, trying all resolved IPs.
bj_bool bj_disable_tcp_keepalive(struct bj_tcp_stream *stream)
Turns off TCP keep-alive probes for a stream.
struct bj_stream * bj_create_stream_from_tcp(struct bj_tcp_stream *tcp, uint32_t flags)
Turns a connected TCP stream into a bj_stream.
struct bj_tcp_stream * bj_accept_tcp_stream(struct bj_tcp_listener *listener, uint32_t ms_timeout, struct bj_error **error)
Accepts an incoming connection on a TCP listener with timeout.
struct bj_tcp_stream * bj_accept_tcp(struct bj_tcp_listener *listener, uint32_t ms_timeout, struct bj_error **error)
void bj_close_tcp_listener(struct bj_tcp_listener *listener)
uint16_t bj_address_port(const struct bj_address *addr)
Gets the port from a resolved address.
bj_bool bj_tcp_has_keepalive(struct bj_tcp_stream *stream)
Reports whether TCP keep-alive is currently enabled on a stream.
int bj_tcp_send(struct bj_tcp_stream *stream, const void *buf, size_t len)
struct bj_tcp_listener * bj_listen_tcp(const char *host, uint16_t port, uint16_t hint, int backlog, struct bj_error **error)
struct bj_tcp_stream * bj_connect_tcp(const char *host, uint16_t port, uint16_t hint, uint32_t ms_timeout, struct bj_error **error)
struct bj_tcp_listener * bj_create_tcp_listener(const char *host, uint16_t port, uint16_t hint, int backlog, struct bj_error **error)
Creates a TCP listener bound to the specified host and port.
bj_bool bj_set_tcp_receive_timeout(struct bj_tcp_stream *stream, uint32_t ms_timeout)
Sets the receive timeout for a TCP stream.
int bj_send_udp(struct bj_udp *udp, const char *host, uint16_t port, const void *data, size_t len, struct bj_error **error)
Sends a datagram to the specified destination.
size_t bj_udp_local_address(const struct bj_udp *udp, char *buf, size_t size)
Gets the local address of a UDP socket (snprintf-style).
bj_bool bj_udp_available(struct bj_udp *udp)
bj_net_shutdown
Shutdown mode for bj_shutdown_tcp.
Definition net.h:256
struct bj_datagram * bj_udp_recv(struct bj_udp *udp, struct bj_error **error)
size_t bj_datagram_address(const struct bj_datagram *dgram, char *buf, size_t size)
Gets the sender's address from a datagram.
void bj_destroy_tcp_stream(struct bj_tcp_stream *stream)
Closes a TCP stream and releases associated resources.
bj_bool bj_tcp_wait(struct bj_tcp_stream *stream, uint32_t ms_timeout)
void bj_close_udp(struct bj_udp *udp)
const void * bj_datagram_data(const struct bj_datagram *dgram)
Gets the data pointer from a datagram.
int bj_udp_send_to(struct bj_udp *udp, const struct bj_address *addr, const void *data, size_t len, struct bj_error **error)
bj_bool bj_udp_wait(struct bj_udp *udp, uint32_t ms_timeout)
size_t bj_address_to_string(const struct bj_address *addr, char *buf, size_t size)
Gets the IP address string from a resolved address.
@ BJ_NET_HINT_EXCLUSIVE_BIND
Disable address reuse.
Definition net.h:123
@ BJ_NET_HINT_BROADCAST
Enable UDP broadcast (SO_BROADCAST).
Definition net.h:126
@ BJ_NET_HINT_NONBLOCKING
Non-blocking mode.
Definition net.h:125
@ BJ_NET_HINT_IPV4
Restrict address resolution to IPv4.
Definition net.h:121
@ BJ_NET_HINT_NONE
No hint provided.
Definition net.h:120
@ BJ_NET_HINT_DELAY_ACK
Enable Nagle's algorithm.
Definition net.h:124
@ BJ_NET_HINT_IPV6
Restrict address resolution to IPv6.
Definition net.h:122
@ BJ_NET_SHUTDOWN_BOTH
Shutdown both send and receive.
Definition net.h:259
@ BJ_NET_SHUTDOWN_RECEIVE
Shutdown receive operations.
Definition net.h:257
@ BJ_NET_SHUTDOWN_SEND
Shutdown send operations.
Definition net.h:258