Interface IServiceApi

Namespace: iMobileDevice.Service

Assembly: iMobileDevice-net.dll

Syntax

public interface IServiceApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.Service.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

service_client_factory_start_service(iDeviceHandle, String, ref IntPtr, String, ref ConstructorFunc, ref Int32)

Starts a new service on the specified device with given name and connects to it.

Declaration

ServiceError service_client_factory_start_service(iDeviceHandle device, string serviceName, ref IntPtr client, string label, ref ConstructorFunc constructorFunc, ref int errorCode)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
System.String	serviceName
System.IntPtr	client	Pointer that will point to a newly allocated service_client_t upon successful return. Must be freed using service_client_free() after use.
System.String	label	The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.
ConstructorFunc	constructorFunc
System.Int32	errorCode

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, or a SERVICE_E_* error code otherwise.

| Improve this Doc View Source

service_client_free(IntPtr)

Frees a service instance.

Declaration

ServiceError service_client_free(IntPtr client)

Parameters

Type	Name	Description
System.IntPtr	client	The service instance to free.

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when client is invalid, or a SERVICE_E_UNKNOWN_ERROR when another error occured.

| Improve this Doc View Source

service_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out ServiceClientHandle)

Creates a new service for the specified service descriptor.

Declaration

ServiceError service_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out ServiceClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
ServiceClientHandle	client	Pointer that will be set to a newly allocated service_client_t upon successful return.

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one of the arguments is invalid, or SERVICE_E_MUX_ERROR when connecting to the device failed.

| Improve this Doc View Source

service_disable_ssl(ServiceClientHandle)

Disable SSL for the given service client.

Declaration

ServiceError service_disable_ssl(ServiceClientHandle client)

Parameters

Type	Name	Description
ServiceClientHandle	client	The connected service client for that SSL should be disabled.

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG if client or client->connection is NULL, or SERVICE_E_UNKNOWN_ERROR otherwise.

| Improve this Doc View Source

service_enable_ssl(ServiceClientHandle)

Enable SSL for the given service client.

Declaration

ServiceError service_enable_ssl(ServiceClientHandle client)

Parameters

Type	Name	Description
ServiceClientHandle	client	The connected service client for that SSL should be enabled.

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG if client or client->connection is NULL, SERVICE_E_SSL_ERROR when SSL could not be enabled, or SERVICE_E_UNKNOWN_ERROR otherwise.

| Improve this Doc View Source

service_receive(ServiceClientHandle, Byte[], UInt32, ref UInt32)

Receives data using the given service client.

Declaration

ServiceError service_receive(ServiceClientHandle client, byte[] data, uint size, ref uint received)

Parameters

Type	Name	Description
ServiceClientHandle	client	The service client to use for receiving
System.Byte[]	data	Buffer that will be filled with the data received
System.UInt32	size	Number of bytes to receive
System.UInt32	received	Number of bytes received (can be NULL to ignore)

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, SERVICE_E_MUX_ERROR when a communication error occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

service_receive_with_timeout(ServiceClientHandle, Byte[], UInt32, ref UInt32, UInt32)

Receives data using the given service client with specified timeout.

Declaration

ServiceError service_receive_with_timeout(ServiceClientHandle client, byte[] data, uint size, ref uint received, uint timeout)

Parameters

Type	Name	Description
ServiceClientHandle	client	The service client to use for receiving
System.Byte[]	data	Buffer that will be filled with the data received
System.UInt32	size	Number of bytes to receive
System.UInt32	received	Number of bytes received (can be NULL to ignore)
System.UInt32	timeout	Maximum time in milliseconds to wait for data.

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, SERVICE_E_MUX_ERROR when a communication error occurs, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

service_send(ServiceClientHandle, Byte[], UInt32, ref UInt32)

Sends data using the given service client.

Declaration

ServiceError service_send(ServiceClientHandle client, byte[] data, uint size, ref uint sent)

Parameters

Type	Name	Description
ServiceClientHandle	client	The service client to use for sending.
System.Byte[]	data	Data to send
System.UInt32	size	Size of the data to send
System.UInt32	sent	Number of bytes sent (can be NULL to ignore)

Returns

Type	Description
ServiceError	SERVICE_E_SUCCESS on success, SERVICE_E_INVALID_ARG when one or more parameters are invalid, or SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs.