mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
054717fd29
Under the cover of the debugger transport layer, allocation on the engine's heap has been made available to the public. As there are actually no restrictions on what the allocated memory can be used for, the memory management functions better fit in the core part of the API. Closes #1805 JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
108 lines
3.7 KiB
C
108 lines
3.7 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef JERRYSCRIPT_DEBUGGER_TRANSPORT_H
|
|
#define JERRYSCRIPT_DEBUGGER_TRANSPORT_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif /* __cplusplus */
|
|
|
|
/** \addtogroup jerry-debugger-transport Jerry engine debugger interface - transport control
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Maximum number of bytes transmitted or received.
|
|
*/
|
|
#define JERRY_DEBUGGER_TRANSPORT_MAX_BUFFER_SIZE 128
|
|
|
|
/**
|
|
* Receive message context.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t *buffer_p; /**< buffer for storing the received data */
|
|
size_t received_length; /**< number of currently received bytes */
|
|
uint8_t *message_p; /**< start of the received message */
|
|
size_t message_length; /**< length of the received message */
|
|
size_t message_total_length; /**< total length for datagram protocols,
|
|
* 0 for stream protocols */
|
|
} jerry_debugger_transport_receive_context_t;
|
|
|
|
/**
|
|
* Forward definition of jerry_debugger_transport_header_t.
|
|
*/
|
|
struct jerry_debugger_transport_interface_t;
|
|
|
|
/**
|
|
* Close connection callback.
|
|
*/
|
|
typedef void (*jerry_debugger_transport_close_t) (struct jerry_debugger_transport_interface_t *header_p);
|
|
|
|
/**
|
|
* Send data callback.
|
|
*/
|
|
typedef bool (*jerry_debugger_transport_send_t) (struct jerry_debugger_transport_interface_t *header_p,
|
|
uint8_t *message_p, size_t message_length);
|
|
|
|
/**
|
|
* Receive data callback.
|
|
*/
|
|
typedef bool (*jerry_debugger_transport_receive_t) (struct jerry_debugger_transport_interface_t *header_p,
|
|
jerry_debugger_transport_receive_context_t *context_p);
|
|
|
|
/**
|
|
* Transport layer header.
|
|
*/
|
|
typedef struct jerry_debugger_transport_interface_t
|
|
{
|
|
/* The following fields must be filled before calling jerry_debugger_transport_add(). */
|
|
jerry_debugger_transport_close_t close; /**< close connection callback */
|
|
jerry_debugger_transport_send_t send; /**< send data callback */
|
|
jerry_debugger_transport_receive_t receive; /**< receive data callback */
|
|
|
|
/* The following fields are filled by jerry_debugger_transport_add(). */
|
|
struct jerry_debugger_transport_interface_t *next_p; /**< next transport layer */
|
|
} jerry_debugger_transport_header_t;
|
|
|
|
void jerry_debugger_transport_add (jerry_debugger_transport_header_t *header_p,
|
|
size_t send_message_header_size, size_t max_send_message_size,
|
|
size_t receive_message_header_size, size_t max_receive_message_size);
|
|
void jerry_debugger_transport_start (void);
|
|
|
|
bool jerry_debugger_transport_is_connected (void);
|
|
void jerry_debugger_transport_close (void);
|
|
|
|
bool jerry_debugger_transport_send (const uint8_t *message_p, size_t message_length);
|
|
bool jerry_debugger_transport_receive (jerry_debugger_transport_receive_context_t *context_p);
|
|
void jerry_debugger_transport_receive_completed (jerry_debugger_transport_receive_context_t *context_p);
|
|
|
|
void jerry_debugger_transport_sleep (void);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif /* !JERRYSCRIPT_DEBUGGER_TRANSPORT_H */
|