Objecte objecte incorporat
  1. portada
  2. Objectes incorporats
  3. Objecte HttpRequest

Objecte HttpRequest

http Sol·licita un objecte de missatge

Herència

#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()

Constructor

HttpRequest

El constructor HttpRequest per crear un nou objecte HttpRequest

1
new HttpRequest();

constant

TEXT

Especifiqueu el tipus de missatge 1, que representa un tipus de text

1
const HttpRequest.TEXT = 1;

BINARY

Especifiqueu el tipus de missatge 2, que representa un tipus binari

1
const HttpRequest.BINARY = 2;

Atributs de membre

response

HttpResponse, Obtén el missatge d'objecte de resposta

1
readonly HttpResponse HttpRequest.response;

method

Cadena, consulta i mètode de sol·licitud d’establiment

1
String HttpRequest.method;

address

Cadena, consulta i defineix l'adreça de sol·licitud

1
String HttpRequest.address;

queryString

Cadena, consulta i configuració de la cadena de consulta de sol·licitud

1
String HttpRequest.queryString;

cookies

HttpCollection, Obteniu el contenidor que conté les cookies de missatges

1
readonly HttpCollection HttpRequest.cookies;

form

HttpCollection, Obteniu el contenidor que conté el formulari de missatge

1
readonly HttpCollection HttpRequest.form;

query

HttpCollection, Obteniu el contenidor que conté la consulta de missatges

1
readonly HttpCollection HttpRequest.query;

protocol

Cadena, informació de la versió del protocol, el format permès és: HTTP /#.#

1
String HttpRequest.protocol;

headers

HttpCollection, Inclòs al missatge http El contenidor de la capçalera del missatge, atribut de només lectura

1
readonly HttpCollection HttpRequest.headers;

keepAlive

Booleà, consulta i defineix si vols mantenir la connexió

1
Boolean HttpRequest.keepAlive;

upgrade

Booleà, consulta i defineix si es tracta d'un acord d'actualització

1
Boolean HttpRequest.upgrade;

maxHeadersCount

Enter, consulteu i definiu el nombre màxim de capçaleres de sol·licitud; el valor per defecte és 128

1
Integer HttpRequest.maxHeadersCount;

maxBodySize

Enter, consulta i estableix la mida màxima del cos, en MB, el valor per defecte és 64

1
Integer HttpRequest.maxBodySize;

socket

Stream, Consulteu el sòcol font de l'objecte actual

1
readonly Stream HttpRequest.socket;

value

String, el contingut bàsic del missatge

1
String HttpRequest.value;

params

NArray, els paràmetres bàsics del missatge

1
readonly NArray HttpRequest.params;

type

Enter, tipus de missatge

1
Integer HttpRequest.type;

data

Valor, consulta les dades del missatge, aquest atribut retornarà dades diferents segons el tipus de contingut, quan sigui text, retorna el text, que és json En tornar json, Altres vegades tornen al binari

1
readonly Value HttpRequest.data;

body

SeekableStream, L'objecte de flux que conté la part de dades del missatge

1
SeekableStream HttpRequest.body;

length

Llarg, la longitud de la part de dades del missatge

1
readonly Long HttpRequest.length;

stream

Stream, Consulteu l'objecte de flux quan el missatge es llegeix des de

1
readonly Stream HttpRequest.stream;

lastError

Cadena, consulta i defineix l'últim error de processament de missatges

1
String HttpRequest.lastError;

Funció de membre

hasHeader

Comproveu si hi ha cap capçalera de missatge amb el valor de clau especificat

1
Boolean HttpRequest.hasHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que voleu comprovar

Resultat de retorn:

  • Boolean, Retorna si el valor de la clau existeix

firstHeader

Consulteu la primera capçalera del missatge del valor de clau especificat

1
String HttpRequest.firstHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal consultar

Resultat de retorn:

  • String, Retorna el valor corresponent al valor clau, si no existeix, torna indefinit

allHeader

Consulteu totes les capçaleres de missatge del valor de clau especificat

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que cal consultar, passeu una cadena buida per retornar el resultat de tots els valors de la clau

Resultat de retorn:

  • NObject, Retorna una matriu de tots els valors corresponents al valor de la clau, si les dades no existeixen, torna nul

addHeader

Afegiu una capçalera de missatge, si afegiu dades no modifiqueu la capçalera del missatge del valor de la clau existent

1
HttpRequest.addHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu el diccionari de dades valor-clau que voleu afegir

Afegiu un conjunt de capçaleres de missatge amb un nom especificat, si afegiu dades no modifiqueu les capçaleres del missatge del valor de la clau existent

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal afegir
  • values: Matriu, especifiqueu un conjunt de dades que voleu afegir

Afegiu una capçalera de missatge, si afegiu dades no modifiqueu la capçalera del missatge del valor de la clau existent

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal afegir
  • value: Cadena, especifiqueu les dades que voleu afegir

setHeader

Definiu una capçalera de missatge, si configureu les dades, es modificarà el primer valor corresponent al valor de la clau i esborraran les capçaleres de missatge restants amb el mateix valor de la clau.

1
HttpRequest.setHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu el diccionari de dades valor-clau que cal establir

Definiu un conjunt de capçaleres de missatge amb un nom especificat, les dades de configuració modificaran el valor corresponent al valor de la clau i esborraran la resta de capçaleres de missatge amb el mateix valor de clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal establir
  • values: Matriu, especifiqueu un conjunt de dades que cal establir

Definiu una capçalera de missatge, si configureu les dades, es modificarà el primer valor corresponent al valor de la clau i esborraran les capçaleres de missatge restants amb el mateix valor de la clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal establir
  • value: Cadena, especifiqueu les dades que voleu establir

removeHeader

Suprimiu totes les capçaleres del missatge del valor de clau especificat

1
HttpRequest.removeHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que voleu suprimir

read

Llegiu les dades de la mida especificada del flux, aquest mètode és l'àlies del mètode de cos corresponent

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

Paràmetres de trucada:

  • bytes: Enter, especifiqueu la quantitat de dades que cal llegir, el valor per defecte és llegir un bloc de dades de mida aleatòria, la mida de les dades llegides depèn del dispositiu

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

readAll

Llegiu totes les dades restants del flux, aquest mètode és un àlies del mètode de cos corresponent

1
Buffer HttpRequest.readAll() async;

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

write

Escriviu les dades donades, aquest mètode és l'àlies del mètode de cos corresponent

1
HttpRequest.write(Buffer data) async;

Paràmetres de trucada:

  • data: Buffer, Tenint en compte les dades a escriure

json

Escriviu les dades donades a la codificació JSON

1
Value HttpRequest.json(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

Analitzeu les dades del missatge a la codificació JSON

1
Value HttpRequest.json();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

pack

per msgpack Codificar per escriure les dades donades

1
Value HttpRequest.pack(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

per msgpack Codificació i anàlisi de les dades del missatge

1
Value HttpRequest.pack();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

end

Definiu el final del processament actual del missatge,Chain El processador no continua les transaccions posteriors

1
HttpRequest.end();

isEnded

Consulteu si el missatge actual s'ha acabat

1
Boolean HttpRequest.isEnded();

Resultat de retorn:

  • Boolean, Torneu a cert al final

clear

Esborreu el contingut del missatge

1
HttpRequest.clear();

sendTo

Envieu un missatge formatat a l'objecte de flux donat

1
HttpRequest.sendTo(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per rebre missatges amb format

readFrom

Llegiu el missatge formatat de l'objecte de flux de memòria cau donat i analitzeu l'objecte d'emplenament

1
HttpRequest.readFrom(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per llegir els missatges formatats

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String HttpRequest.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable
© Copyright 2012-2021 fibjs.org | Doneu-nos suport