pascal jsonrpc lite

Pascal JSON-RPC LITE

Analisar e serializar mensagens JSON-RPC2 no aplicativo Pascal Free-Pascal ou Delphi. Repositório Git: https://github.com/r3code/pascal-jsonrpc-lite

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

Uma implementação das especificações JSON-RPC 2.0

Instalar

1. Download.
2. Extrair.
3. Adicione ujsonrpc.pas ao seu projeto ou adicione o caminho a ujsonrpc.pas ao caminho da lib.

 uses ujsonrpc;

API

Interface: ijsonrpcMessage

Método: ijsonrpcmessage.asjsonObject

Retorna objeto como isuperObject clonned formulário interno JSON-Object.

Método: ijsonrpcmessage.asjson (Recunda: boolean = false; escape: boolean = true): string;

Retorna uma representação do objeto de string json.

Params:

• indent : {boolean} Recunda JSON resultante
• escape : {boolean} escapar de chars especiais

Classe: TjsonrpcMessage

Método de classe: tjsonrpcmessage.request (id, método, params)

Cria um objeto de solicitação JSON-RPC 2.0, retorne o objeto ijsonrpcMessage. Percebe ijsonrpcmessage.

Params:

• id : {String | Inteiro}
• method : {string}
• params : {ijsonrpcmessage}

Exemplo:

 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 classe: tjsonrpcmessage.notification (método, params)

Cria um objeto de notificação JSON-RPC 2.0, retorna o objeto ijsonrpcMessage.

Params:

• method : {string}
• params : {ijsonrpcmessage}

Exemplo:

 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 classe: tjsonrpcmessage.success (id, resultado)

Cria um objeto de resposta de sucesso JSON-RPC 2.0, retorna o objeto ijsonrpcMessage.

Params:

• id : {String | Inteiro}
• result : {ijsonrpcmessage}

Exemplo:

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

Método de classe: tjsonrpcmessage.error (id, erro)

Cria um objeto de resposta de erro JSON-RPC 2.0, retorne o objeto ijsonrpcMessage.

Params:

• id : {String | Inteiro}
• error : {ijsonrpcmessage} use tjsonrpCerror ou seus irmãos

Exemplo:

 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 classe: tjsonrpcmessage.parse (s) (s) (s)

Pega uma carga útil JSON-RPC 2.0 (string) e tenta analisá-la em um JSON. Se for bem -sucedido, determine qual objeto é (resposta, notificação, sucesso, erro ou inválido) e retorne seu tipo e objeto adequadamente formatado.

Params:

• s : {string}

Retorna um objeto de {ijsonrpcparsed}.

Enum: tjsonrpCObjectType

Mostra o tipo de mensagem detectada durante a análise. Tipos: JotInValid, JotRequest, JotNotification, Jotsuccess, Joterror.

Interface: ijsonrpcparsed

Método: ijsonrpcparsed.getMessageType

Retorna um dos <{jsonrpCObjectType}.

Método: ijsonrpcparsed.getMessagePayload

Retorna o referência armazenado para ijsonrpcMessage.

Classe: tjsonrpcparsed

Percebe a interface ijsonrpcparsed.

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

Crie uma instância TJSONRPCPARSED.

Params:

• objType : {tjsonrpCObjectType} Formato de mensagem Tipo
• payload : {ijsonrpcmessage} corpo de mensagem

Classe: TjsonrpCerror

Descreve o objeto de erro JSON-RPC 2.0. Realiza interface ijsonrpcMessage.

Construtor: tjsonrpCerror.create (código, mensagem [, dados])

Crie uma instância TJSONRPCERROR.

Params:

• code : {Inteiro}
• message : {string}
• data : {string | isUperObject | nil} opcional

Exemplos:

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

ou

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

Método de classe: tjsonrpcerror.InValidRequest (dados)

Criar {TjsonrpCerror} objeto com código de erro -32600.

Params:

• data : {string | isUperObject | nil} - dados extras

Método de classe: tjsonrpcerror.methodnotfound (dados)

Crie {tjsonrpCerror} objeto com código de erro -32601.

Params:

• data : {string | isUperObject | nil} - dados extras

Método de classe: tjsonrpcerror.invalidParams (dados)

Crie {tjsonrpCerror} objeto com código de erro -32602.

Params:

• data : {string | isUperObject | nil} - dados extras

Método de classe: tjsonrpcerror.internalError (dados)

Crie {TjsonrpCerror} objeto com código de erro -32603.

Params:

• data : {string | isUperObject | nil} - dados extras

Método de classe: tjsonrpcerror.parseerror (dados)

Crie {TjsonrpCerror} objeto com código de erro -32700.

Params:

• data : {string} - texto de erro