pascal jsonrpc lite

Pascal JSON-RPC Lite

Analice los mensajes JSON-RPC2 en la aplicación Free-Pascal o Delphi. Repositorio de git: https://github.com/r3code/pascal-jsonrpc-lite

Inspirado en https://github.com/teambition/jsonrpc-lite.

Una implementación de las especificaciones de JSON-RPC 2.0

Instalar

1. Descargar.
2. Extracto.
3. Agregue UJSONRPC.PAS a su proyecto o agregue la ruta a UJSONRPC.PAS a la ruta lib.

 uses ujsonrpc;

API

Interfaz: iJsonRPCMessage

Método: ijsonrpcmessage.asjsonObject

Devuelve el objeto como ISuperObject clonado de forma interna JSON-Object.

Método: ijsonrpcMessage.asjson (indent: boolean = false; escudo: boolean = true): string;

Devuelve una representación del objeto de cadena JSON.

Parámetros:

• indent : {boolean} sangría resultante JSON
• escape : {boolean} Escape Special Chars

Clase: TJSONRPCMessage

Método de clase: tjsonrpcMessage.Request (id, método, parámetros)

Crea un objeto de solicitud JSON-RPC 2.0, devuelve el objeto IJSONRPCMessage. Se da cuenta de IJSONRPCMessage.

Parámetros:

• id : {String | Integer}
• method : {String}
• params : {iJsonRPCMessage}

Ejemplo:

 var requestObj: TJsonRpcMessage; 
requestObj := TJsonRpcMessage.Request( ' 123 ' , ' update ' , SO( ' {list: [1, 2, 3]} ' ));
writeln(requestObj.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   method: 'update',
//   params: {list: [1, 2, 3]}
// } 

Método de clase: tjsonrpcMessage.notification (método, params)

Crea un objeto de notificación JSON-RPC 2.0, devuelve el objeto IJSONRPCMessage.

Parámetros:

• method : {String}
• params : {iJsonRPCMessage}

Ejemplo:

 var notificationObj: TJsonRpcMessage;
notificationObj := TJsonRpcMessage.notification( ' update ' , SO( ' {list: [1, 2, 3]} ' ));
writeln(notificationObj.asString);
// {
//   jsonrpc: '2.0',
//   method: 'update',
//   params: {list: [1, 2, 3]}
// } 

Método de clase: tjsonrpcMessage.success (ID, resultado)

Crea un objeto de respuesta de éxito JSON-RPC 2.0, return IJsonRPCMessage Object.

Parámetros:

• id : {String | Integer}
• result : {iJsonRPCMessage}

Ejemplo:

 var msg: TJsonRpcMessage;
msg := TJsonRpcMessage.success( ' 123 ' , ' OK ' );
writeln(msg.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   result: 'OK',
// } 

Método de clase: tjsonrpcmessage.error (ID, error)

Crea un objeto de respuesta de error JSON-RPC 2.0, return IJSONRPCMessage Object.

Parámetros:

• id : {String | Integer}
• error : {IJSONRPCMESSAGE} use tjsonrpcerror o sus hermanos

Ejemplo:

 var msg: TJsonRpcMessage;
msg := TJsonRpcMessage.Error( ' 123 ' , TJsonRpcError.Create(- 32000 , ' some error ' , ' blabla ' ));
writeln(msg.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   error: {code: -32000, 'message': 'some error', data: 'blabla'},
// } 

Método de clase: TJSONRPCMESSAGE.PARSE (S)

Toma una carga útil JSON-RPC 2.0 (cadena) e intenta analizarla en un JSON. Si tiene éxito, determine qué objeto es (respuesta, notificación, éxito, error o inválido), y devuelva su tipo y objeto formateado correctamente.

Parámetros:

• s : {String}

Devuelve un objeto de {ijsonrpcparsed}.

Enum: tjsonrpcObjectType

Muestra el tipo de mensaje detectado durante el análisis. Tipos: Jotinvalid, JotRequest, Jotnotification, Jotsuccess, Joterror.

Interfaz: ijsonrpcparsed

Método: ijsonrpcparsed.getMessageType

Devuelve uno de <{JSONRPCObjectType}.

Método: ijsonrpcparsed.getMessagePayload

Devuelve la referencia almacenada a IJSONRPCMessage.

Clase: TJSONRPCPARSED

Realiza la interfaz ijsonrpcparsed.

Constructor: tjsonrpcparsed.create (objtype, carga útil)

Crea una instancia TJSONRPCParsed.

Parámetros:

• objType : {tjsonrpcObjectType} Tipo de formato de mensaje
• payload : {IJSONRPCMessage} Mensaje Cuerpo

Clase: tjsonrpcerror

Describe el objeto de error JSON-RPC 2.0. Realiza la interfaz iJsonRPCMessage.

Constructor: tjsonrpcerror.create (código, mensaje [, datos])

Crea una instancia tjsonrpcerror.

Parámetros:

• code : {Integer}
• message : {String}
• data : {String | isuperObject | nil} opcional

Ejemplos:

 var error: TJsonRpcError;
error =  TJsonRpcError.Create(- 32651 , ' some error ' , ' some data ' );

o

 var error: TJsonRpcError;
error =  TJsonRpcError.Create(- 32651 , ' some error ' , SO( ' { a: 1, extra: "some data"} ' ));

Método de clase: tjsonrpcerror.invalidRequest (datos)

Crear {TJSONRPCError} objeto con código de error -32600.

Parámetros:

• data : {String | isuperObject | nil} - datos adicionales

Método de clase: tjsonrpcerror.methodnotFound (datos)

Crear {TJSONRPCError} objeto con código de error -32601.

Parámetros:

• data : {String | isuperObject | nil} - datos adicionales

Método de clase: tjsonrpcerror.invalidParams (datos)

Crear {tjsonrpcerror} objeto con código de error -32602.

Parámetros:

• data : {String | isuperObject | nil} - datos adicionales

Método de clase: tjsonrpcerror.internalError (datos)

Crear {TJSONRPCError} objeto con código de error -32603.

Parámetros:

• data : {String | isuperObject | nil} - datos adicionales

Método de clase: tjsonrpcerror.parseError (datos)

Crear {TJSONRPCError} objeto con código de error -32700.

Parámetros:

• data : {String} - Texto de error