errors.h File Reference

Network error handling utilities. More...

Go to the source code of this file.

Functions
asciichat_error_t	send_error_packet (socket_t sockfd, asciichat_error_t error_code)
	Send an ACIP error packet using asciichat_error_t.
asciichat_error_t	send_error_packet_message (socket_t sockfd, asciichat_error_t error_code, const char *message)
	Send an ACIP error packet with custom message.
bool	check_and_record_rate_limit (rate_limiter_t *rate_limiter, const char *client_ip, rate_event_type_t event_type, socket_t client_socket, const char *operation_name)
	Check rate limit and send error if exceeded.
bool	check_and_record_packet_rate_limit (rate_limiter_t *rate_limiter, const char *client_ip, socket_t client_socket, packet_type_t packet_type)
	Map packet type to rate event type and check rate limit.

Detailed Description

Network error handling utilities.

Provides helper functions for sending error responses and handling common error patterns in network protocols.

Definition in file errors.h.

Function Documentation

check_and_record_packet_rate_limit()

bool check_and_record_packet_rate_limit	(	rate_limiter_t *	rate_limiter,
		const char *	client_ip,
		socket_t	client_socket,
		packet_type_t	packet_type
	)

Map packet type to rate event type and check rate limit.

Maps packet_type_t to the corresponding rate_event_type_t and performs rate limiting check. Sends ERROR_RATE_LIMITED response if exceeded.

Packet type to rate event mapping:

• IMAGE_FRAME -> RATE_EVENT_IMAGE_FRAME
• AUDIO, AUDIO_BATCH, AUDIO_OPUS, AUDIO_OPUS_BATCH -> RATE_EVENT_AUDIO
• PING, PONG -> RATE_EVENT_PING
• CLIENT_JOIN -> RATE_EVENT_CLIENT_JOIN
• CLIENT_CAPABILITIES, STREAM_START, STREAM_STOP, CLIENT_LEAVE -> RATE_EVENT_CONTROL
• All other packets -> No rate limiting (always allowed)

Parameters

rate_limiter	Rate limiter instance
client_ip	Client IP address
client_socket	Client socket for sending error response
packet_type	Packet type being processed

Returns

true if allowed (and event recorded), false if rate limited

Definition at line 54 of file errors.c.

                                                                   {
  // Map packet type to rate event type
  rate_event_type_t event_type;
  const char *packet_name;
 
  switch (packet_type) {
  case PACKET_TYPE_IMAGE_FRAME:
    event_type = RATE_EVENT_IMAGE_FRAME;
    packet_name = "IMAGE_FRAME";
    break;
 
  case PACKET_TYPE_AUDIO:
  case PACKET_TYPE_AUDIO_BATCH:
  case PACKET_TYPE_AUDIO_OPUS:
  case PACKET_TYPE_AUDIO_OPUS_BATCH:
    event_type = RATE_EVENT_AUDIO;
    packet_name = "AUDIO";
    break;
 
  case PACKET_TYPE_PING:
  case PACKET_TYPE_PONG:
    event_type = RATE_EVENT_PING;
    packet_name = "PING";
    break;
 
  case PACKET_TYPE_CLIENT_JOIN:
    event_type = RATE_EVENT_CLIENT_JOIN;
    packet_name = "CLIENT_JOIN";
    break;
 
  case PACKET_TYPE_CLIENT_CAPABILITIES:
  case PACKET_TYPE_STREAM_START:
  case PACKET_TYPE_STREAM_STOP:
  case PACKET_TYPE_CLIENT_LEAVE:
    event_type = RATE_EVENT_CONTROL;
    packet_name = "CONTROL";
    break;
 
  default:
    // No rate limiting for other packet types
    return true;
  }
 
  // Use the existing check_and_record_rate_limit function
  return check_and_record_rate_limit(rate_limiter, client_ip, event_type, client_socket, packet_name);
}

References check_and_record_rate_limit(), PACKET_TYPE_AUDIO, PACKET_TYPE_AUDIO_BATCH, PACKET_TYPE_AUDIO_OPUS, PACKET_TYPE_AUDIO_OPUS_BATCH, PACKET_TYPE_CLIENT_CAPABILITIES, PACKET_TYPE_CLIENT_JOIN, PACKET_TYPE_CLIENT_LEAVE, PACKET_TYPE_IMAGE_FRAME, PACKET_TYPE_PING, PACKET_TYPE_PONG, PACKET_TYPE_STREAM_START, PACKET_TYPE_STREAM_STOP, RATE_EVENT_AUDIO, RATE_EVENT_CLIENT_JOIN, RATE_EVENT_CONTROL, RATE_EVENT_IMAGE_FRAME, and RATE_EVENT_PING.

Referenced by process_decrypted_packet().

check_and_record_rate_limit()

bool check_and_record_rate_limit	(	rate_limiter_t *	rate_limiter,
		const char *	client_ip,
		rate_event_type_t	event_type,
		socket_t	client_socket,
		const char *	operation_name
	)

Check rate limit and send error if exceeded.

Helper function that checks rate limit, sends error response if exceeded, and records the event if allowed. Encapsulates the common pattern:

1. Check rate limit
2. Send ERROR_RATE_LIMITED if exceeded
3. Record event if allowed

Parameters

rate_limiter	Rate limiter instance
client_ip	Client IP address for logging
event_type	Type of event being rate limited
client_socket	Socket to send error packet on
operation_name	Name of operation for logging (e.g., "SESSION_CREATE")

Returns

true if allowed (and event recorded), false if rate limited

Definition at line 38 of file errors.c.

                                                                                     {
  bool allowed = false;
  asciichat_error_t rate_check = rate_limiter_check(rate_limiter, client_ip, event_type, NULL, &allowed);
 
  if (rate_check != ASCIICHAT_OK || !allowed) {
    send_error_packet_message(client_socket, ERROR_RATE_LIMITED, "Rate limit exceeded. Please try again later.");
    log_warn("Rate limit exceeded for %s from %s", operation_name, client_ip);
    return false;
  }
 
  // Record the rate limit event
  rate_limiter_record(rate_limiter, client_ip, event_type);
  return true;
}

References ASCIICHAT_OK, ERROR_RATE_LIMITED, log_warn, rate_limiter_check(), rate_limiter_record(), and send_error_packet_message().

Referenced by check_and_record_packet_rate_limit().

send_error_packet()

asciichat_error_t send_error_packet	(	socket_t	sockfd,
		asciichat_error_t	error_code
	)

Send an ACIP error packet using asciichat_error_t.

Converts an asciichat_error_t code to an ACIP error packet and sends it. Uses asciichat_error_string() for the error message.

Parameters

sockfd	Socket to send error on
error_code	Error code from asciichat_error_t enum

Returns

ASCIICHAT_OK on success, error code on failure

Definition at line 11 of file errors.c.

                                                                                   {
  return send_error_packet_message(sockfd, error_code, asciichat_error_string(error_code));
}

References error_code, and send_error_packet_message().

send_error_packet_message()

asciichat_error_t send_error_packet_message	(	socket_t	sockfd,
		asciichat_error_t	error_code,
		const char *	message
	)

Send an ACIP error packet with custom message.

Converts an asciichat_error_t code to an ACIP error packet with a custom error message.

Parameters

sockfd	Socket to send error on
error_code	Error code from asciichat_error_t enum
message	Custom error message (max 255 chars)

Returns

ASCIICHAT_OK on success, error code on failure

Definition at line 15 of file errors.c.

                                                                                                                {
  if (sockfd == INVALID_SOCKET_VALUE) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid socket");
  }
 
  if (!message) {
    message = asciichat_error_string(error_code);
  }
 
  // Construct ACIP error packet
  acip_error_t error = {0};
  error.error_code = (uint8_t)error_code;
  SAFE_STRNCPY(error.error_message, message, sizeof(error.error_message));
 
  // Send error packet
  int result = send_packet(sockfd, PACKET_TYPE_ACIP_ERROR, &error, sizeof(error));
  if (result < 0) {
    return SET_ERRNO(ERROR_NETWORK, "Failed to send error packet");
  }
 
  return ASCIICHAT_OK;
}

References acip_error_t, ASCIICHAT_OK, error_code, ERROR_INVALID_PARAM, ERROR_NETWORK, INVALID_SOCKET_VALUE, PACKET_TYPE_ACIP_ERROR, SAFE_STRNCPY, send_packet(), and SET_ERRNO.

Referenced by check_and_record_rate_limit(), and send_error_packet().