Oggetto oggetto incorporato

Oggetto HTTPRequest

http Richiedi oggetto messaggio

Eredità

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<class>HttpMessage|protocol;headers;keepAlive;upgrade;maxHeadersCount;maxBodySize;socket|hasHeader();firstHeader();allHeader();addHeader();setHeader();removeHeader()] [<this>HttpRequest|new HttpRequest()|response;method;address;queryString;cookies;form;query] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() HttpRequest new HttpRequest() response method address queryString cookies form query object toString() toJSON()

Costruttore

HttpRequest

Costruttore HttpRequest per creare un nuovo oggetto HttpRequest

1
new HttpRequest();

costante

TEXT

Specifica il tipo di messaggio 1, che rappresenta un tipo di testo text

1
const HttpRequest.TEXT = 1;

BINARY

Specificare il tipo di messaggio 2, che rappresenta un tipo binario

1
const HttpRequest.BINARY = 2;

Attributi dei membri

response

HttpResponse, Ottieni oggetto messaggio di risposta

1
readonly HttpResponse HttpRequest.response;

method

Stringa, interroga e imposta il metodo di richiesta

1
String HttpRequest.method;

address

Stringa, interroga e imposta l'indirizzo della richiesta

1
String HttpRequest.address;

queryString

Stringa, interroga e imposta la stringa di query della richiesta

1
String HttpRequest.queryString;

cookies

HttpCollection, Ottieni il contenitore contenente i cookie del messaggio

1
readonly HttpCollection HttpRequest.cookies;

form

HttpCollection, Ottieni il contenitore contenente il modulo del messaggio

1
readonly HttpCollection HttpRequest.form;

query

HttpCollection, Ottieni il contenitore contenente la query del messaggio

1
readonly HttpCollection HttpRequest.query;

protocol

Stringa, informazioni sulla versione del protocollo, il formato consentito è: HTTP/#.#

1
String HttpRequest.protocol;

headers

HttpCollection, Incluso nel messaggio http Il contenitore dell'intestazione del messaggio, attributo di sola lettura

1
readonly HttpCollection HttpRequest.headers;

keepAlive

Boolean, interroga e imposta se mantenere la connessione

1
Boolean HttpRequest.keepAlive;

upgrade

Boolean, interroga e imposta se si tratta di un accordo di aggiornamento

1
Boolean HttpRequest.upgrade;

maxHeadersCount

Intero, interroga e imposta il numero massimo di intestazioni di richiesta, il valore predefinito è 128

1
Integer HttpRequest.maxHeadersCount;

maxBodySize

Intero, interroga e imposta la dimensione massima del corpo, in MB, il valore predefinito è 64

1
Integer HttpRequest.maxBodySize;

socket

Stream, Interroga il socket di origine dell'oggetto corrente

1
readonly Stream HttpRequest.socket;

value

String, il contenuto base del messaggio

1
String HttpRequest.value;

params

NArray, i parametri base del messaggio

1
readonly NArray HttpRequest.params;

type

Intero, tipo di messaggio

1
Integer HttpRequest.type;

data

Valore, interroga i dati del messaggio, questo attributo restituirà dati diversi a seconda del tipo di contenuto, quando è testo, restituisce il testo, che è json Al ritorno json, Altre volte torna al binario

1
readonly Value HttpRequest.data;

body

SeekableStream, L'oggetto stream che contiene la parte dati del messaggio

1
SeekableStream HttpRequest.body;

length

Long, la lunghezza della parte dati del messaggio

1
readonly Long HttpRequest.length;

stream

Stream, Interroga l'oggetto stream quando il messaggio readFrom

1
readonly Stream HttpRequest.stream;

lastError

Stringa, interroga e imposta l'ultimo errore di elaborazione del messaggio

1
String HttpRequest.lastError;

Funzione membro

hasHeader

Controlla se c'è un'intestazione del messaggio con il valore della chiave specificato

1
Boolean HttpRequest.hasHeader(String name);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da controllare

Risultato di ritorno:

  • Boolean, restituisce se il valore della chiave esiste

firstHeader

Interroga l'intestazione del primo messaggio del valore chiave specificato

1
String HttpRequest.firstHeader(String name);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da interrogare

Risultato di ritorno:

  • String, Restituisce il valore corrispondente al valore della chiave, se non esiste restituisce undefined

allHeader

Interroga tutte le intestazioni dei messaggi del valore chiave specificato

1
NObject HttpRequest.allHeader(String name = "");

Parametri di chiamata:

  • name: String, specifica il valore della chiave da interrogare, passa una stringa vuota per restituire il risultato di tutti i valori della chiave

Risultato di ritorno:

  • NObject, Restituisce un array di tutti i valori corrispondenti al valore della chiave, se i dati non esistono, restituisce null

addHeader

Aggiungi un'intestazione del messaggio, l'aggiunta di dati non modifica l'intestazione del messaggio del valore della chiave esistente

1
HttpRequest.addHeader(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare il dizionario dati chiave-valore da aggiungere

Aggiungi una serie di intestazioni dei messaggi con un nome specificato, l'aggiunta di dati non modifica le intestazioni dei messaggi del valore della chiave esistente

1 2
HttpRequest.addHeader(String name, Array values);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da aggiungere
  • values: Array, specifica un insieme di dati da aggiungere

Aggiungi un'intestazione del messaggio, l'aggiunta di dati non modifica l'intestazione del messaggio del valore della chiave esistente

1 2
HttpRequest.addHeader(String name, String value);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da aggiungere
  • value: Stringa, specifica i dati da aggiungere

setHeader

Imposta un'intestazione del messaggio, i dati di impostazione modificheranno il primo valore corrispondente al valore della chiave e cancelleranno le intestazioni dei messaggi rimanenti con lo stesso valore della chiave

1
HttpRequest.setHeader(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare il dizionario dati chiave-valore da impostare

Imposta una serie di intestazioni del messaggio con un nome specificato, i dati di impostazione modificheranno il valore corrispondente al valore della chiave e cancelleranno il resto delle intestazioni del messaggio con lo stesso valore della chiave

1 2
HttpRequest.setHeader(String name, Array values);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da impostare
  • values: Array, specifica un insieme di dati da impostare

Imposta un'intestazione del messaggio, i dati di impostazione modificheranno il primo valore corrispondente al valore della chiave e cancelleranno le intestazioni dei messaggi rimanenti con lo stesso valore della chiave

1 2
HttpRequest.setHeader(String name, String value);

Parametri di chiamata:

  • name: String, specifica il valore della chiave da impostare
  • value: Stringa, specifica i dati da impostare

removeHeader

Elimina tutte le intestazioni dei messaggi del valore chiave specificato

1
HttpRequest.removeHeader(String name);

Parametri di chiamata:

  • name: String, specifica la chiave da eliminare

read

Leggi i dati della dimensione specificata dal flusso, questo metodo è l'alias del metodo corrispondente di body

1
Buffer HttpRequest.read(Integer bytes = -1) async;

Parametri di chiamata:

  • bytes: Intero, specificare la quantità di dati da leggere, l'impostazione predefinita è leggere un blocco dati di dimensioni casuali, la dimensione dei dati letti dipende dal dispositivo

Risultato di ritorno:

  • Buffer, Restituisce i dati letti dal flusso, se non ci sono dati da leggere o la connessione viene interrotta, restituisce null return

readAll

Leggi tutti i dati rimanenti dal flusso, questo metodo è un alias del corrispondente metodo di body

1
Buffer HttpRequest.readAll() async;

Risultato di ritorno:

  • Buffer, Restituisce i dati letti dal flusso, se non ci sono dati da leggere o la connessione viene interrotta, restituisce null return

write

Scrivi i dati forniti, questo metodo è l'alias del corrispondente metodo di body

1
HttpRequest.write(Buffer data) async;

Parametri di chiamata:

  • data: Buffer, Dati i dati da scrivere

json

Scrivi i dati forniti nella codifica JSON

1
Value HttpRequest.json(Value data);

Parametri di chiamata:

  • data: Valore, dati i dati da scrivere

Risultato di ritorno:

  • Value, Questo metodo non restituirà dati

Analizza i dati nel messaggio nella codifica JSON

1
Value HttpRequest.json();

Risultato di ritorno:

  • Value, Restituisce il risultato analizzato

pack

Per msgpack Codifica per scrivere i dati forniti

1
Value HttpRequest.pack(Value data);

Parametri di chiamata:

  • data: Valore, dati i dati da scrivere

Risultato di ritorno:

  • Value, Questo metodo non restituirà dati

Per msgpack Codifica e analisi dei dati nel messaggio

1
Value HttpRequest.pack();

Risultato di ritorno:

  • Value, Restituisce il risultato analizzato

end

Imposta la fine dell'elaborazione del messaggio corrente,Chain Il processore non continua le transazioni successive

1
HttpRequest.end();

isEnded

Interroga se il messaggio corrente è finito

1
Boolean HttpRequest.isEnded();

Risultato di ritorno:

  • Boolean, restituisce true alla fine

clear

Cancella il contenuto del messaggio

1
HttpRequest.clear();

sendTo

Invia un messaggio formattato all'oggetto stream specificato

1
HttpRequest.sendTo(Stream stm) async;

Parametri di chiamata:

  • stm: Stream, Specificare l'oggetto stream per ricevere i messaggi formattati

readFrom

Leggi il messaggio formattato dall'oggetto del flusso di cache specificato e analizza l'oggetto di riempimento

1
HttpRequest.readFrom(Stream stm) async;

Parametri di chiamata:

  • stm: Stream, Specifica l'oggetto stream per leggere i messaggi formattati

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere re-implementato secondo le proprie caratteristiche

1
String HttpRequest.toString();

Risultato di ritorno:

  • String, Restituisce la rappresentazione di stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, generalmente restituisce una raccolta di attributi leggibili definiti dall'oggetto

1
Value HttpRequest.toJSON(String key = "");

Parametri di chiamata:

  • key: Stringa, inutilizzata

Risultato di ritorno:

  • Value, Restituisce un valore contenente JSON serializzabile