WebKit Remote Debugging.
More...
|
#define | WEBINSPECTOR_SERVICE_NAME "com.apple.webinspector" |
|
|
typedef struct webinspector_client_private | webinspector_client_private |
|
typedef webinspector_client_private * | webinspector_client_t |
| The client handle.
|
|
|
enum | webinspector_error_t {
WEBINSPECTOR_E_SUCCESS = 0,
WEBINSPECTOR_E_INVALID_ARG = -1,
WEBINSPECTOR_E_PLIST_ERROR = -2,
WEBINSPECTOR_E_MUX_ERROR = -3,
WEBINSPECTOR_E_SSL_ERROR = -4,
WEBINSPECTOR_E_UNKNOWN_ERROR = -256
} |
| Error Codes.
|
|
◆ webinspector_client_free()
Disconnects a webinspector client from the device and frees up the webinspector client data.
- Parameters
-
client | The webinspector client to disconnect and free. |
- Returns
- WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client is NULL, or an WEBINSPECTOR_E_* error code otherwise.
◆ webinspector_client_new()
Connects to the webinspector service on the specified device.
- Parameters
-
device | The device to connect to. |
service | The service descriptor returned by lockdownd_start_service. |
client | Pointer that will point to a newly allocated webinspector_client_t upon successful return. Must be freed using webinspector_client_free() after use. |
- Returns
- WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client is NULL, or an WEBINSPECTOR_E_* error code otherwise.
◆ webinspector_client_start_service()
Starts a new webinspector service on the specified device and connects to it.
- Parameters
-
device | The device to connect to. |
client | Pointer that will point to a newly allocated webinspector_client_t upon successful return. Must be freed using webinspector_client_free() after use. |
label | The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd. |
- Returns
- WEBINSPECTOR_E_SUCCESS on success, or an WEBINSPECTOR_E_* error code otherwise.
◆ webinspector_receive()
Receives a plist from the service.
- Parameters
-
client | The webinspector client |
plist | The plist to store the received data |
- Returns
- DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL
◆ webinspector_receive_with_timeout()
Receives a plist using the given webinspector client.
- Parameters
-
client | The webinspector client to use for receiving |
plist | pointer to a plist_t that will point to the received plist upon successful return |
timeout | Maximum time in milliseconds to wait for data. |
- Returns
- WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client or *plist is NULL, WEBINSPECTOR_E_PLIST_ERROR when the received data cannot be converted to a plist, WEBINSPECTOR_E_MUX_ERROR when a communication error occurs, or WEBINSPECTOR_E_UNKNOWN_ERROR when an unspecified error occurs.
◆ webinspector_send()
Sends a plist to the service.
- Parameters
-
client | The webinspector client |
plist | The plist to send |
- Returns
- DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL