user_pipe.h File Reference

#include <zephyr/modem/chat.h>

Go to the source code of this file.

Functions
int	modem_at_user_pipe_claim (struct modem_chat *chat, k_timeout_t timeout)
	Claim the AT command user pipe to run commands.
void	modem_at_user_pipe_release (void)
	Release the AT command user pipe to other users.

Function Documentation

modem_at_user_pipe_claim()

int modem_at_user_pipe_claim	(	struct modem_chat *	chat,
		k_timeout_t	timeout )

Claim the AT command user pipe to run commands.

Note

This function will not block if the underlying pipe is not opened

All pending data in the pipe is drained before the chat instance is attached

Parameters

chat	Chat instance that will be used with the user pipe
timeout	Maximum duration to wait for other users to release the pipe

Return values

0	On success
-EPERM	Modem is not ready
-EBUSY	User pipe already claimed

modem_at_user_pipe_release()

void modem_at_user_pipe_release

(

void

)

Release the AT command user pipe to other users.

Must be called after modem_at_user_pipe_claim when pipe is no longer in use.