Objet objet intégré
  1. page de garde
  2. Objets intégrés
  3. Objet HttpResponse

Objet HttpResponse

http Objet de message de réponse

Héritage

#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>HttpResponse|new HttpResponse()|statusCode;statusMessage;cookies|writeHead();addCookie();redirect();sendHeader()] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpResponse] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() HttpResponse new HttpResponse() statusCode statusMessage cookies writeHead() addCookie() redirect() sendHeader() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() object toString() toJSON()

Constructeur

HttpResponse

Constructeur HttpResponse pour créer un nouvel objet HttpResponse

1
new HttpResponse();

constant

TEXT

Spécifiez le type de message 1, qui représente un type de texte

1
const HttpResponse.TEXT = 1;

BINARY

Spécifiez le type de message 2, qui représente un type binaire

1
const HttpResponse.BINARY = 2;

Attributs des membres

statusCode

Entier, interroger et définir le statut de retour du message de réponse

1
Integer HttpResponse.statusCode;

statusMessage

Chaîne, requête et définition du message de retour du message de réponse

1
String HttpResponse.statusMessage;

cookies

NArray, renvoie le message actuel HttpCookie Liste d'objets

1
readonly NArray HttpResponse.cookies;

protocol

Chaîne, informations sur la version du protocole, le format autorisé est : HTTP/#.#

1
String HttpResponse.protocol;

headers

HttpCollection, Inclus dans le message http Le conteneur de l'en-tête du message, attribut en lecture seule

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booléen, interroge et définit s'il faut conserver la connexion

1
Boolean HttpResponse.keepAlive;

upgrade

Booléen, interroge et définit s'il s'agit d'un accord de mise à niveau

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Entier, interrogez et définissez le nombre maximal d'en-têtes de requête, la valeur par défaut est 128

1
Integer HttpResponse.maxHeadersCount;

maxBodySize

Entier, interrogez et définissez la taille maximale du corps, en Mo, la valeur par défaut est 64

1
Integer HttpResponse.maxBodySize;

socket

Stream, Interroger la socket source de l'objet courant

1
readonly Stream HttpResponse.socket;

value

String, le contenu de base du message

1
String HttpResponse.value;

params

NArray, les paramètres de base du message

1
readonly NArray HttpResponse.params;

type

Entier, type de message

1
Integer HttpResponse.type;

data

Value, interroge les données du message, cet attribut renverra des données différentes selon le type de contenu, lorsqu'il s'agit de texte, il renvoie le texte, qui est json Au retour json, D'autres fois retournent au binaire

1
readonly Value HttpResponse.data;

body

SeekableStream, L'objet de flux qui contient la partie données du message

1
SeekableStream HttpResponse.body;

length

Long, la longueur de la partie données du message

1
readonly Long HttpResponse.length;

stream

Stream, Interrogez l'objet de flux lorsque le message readFrom

1
readonly Stream HttpResponse.stream;

lastError

Chaîne, requête et définition de la dernière erreur de traitement du message

1
String HttpResponse.lastError;

Fonction membre

writeHead

Définir l'état de retour du message de réponse, renvoyer le message et ajouter l'en-tête de réponse

1
2
3
HttpResponse.writeHead(Integer statusCode,
    String statusMessage,
    Object headers = {});

Paramètres d'appel :

  • statusCode: Entier, spécifiez le statut de retour du message de réponse
  • statusMessage: String, spécifiez le message de retour du message de réponse
  • headers: Objet, spécifiez l'en-tête de réponse ajouté au message de réponse

Définir l'état de retour du message de réponse, renvoyer le message et ajouter l'en-tête de réponse

1
2
HttpResponse.writeHead(Integer statusCode,
    Object headers = {});

Paramètres d'appel :

  • statusCode: Entier, spécifiez le statut de retour du message de réponse
  • headers: Objet, spécifiez l'en-tête de réponse ajouté au message de réponse

addCookie

Ajouter un aux cookies HttpCookie Objet

1
HttpResponse.addCookie(HttpCookie cookie);

Paramètres d'appel :

redirect

Envoyer une redirection au client

1
HttpResponse.redirect(String url);

Paramètres d'appel :

  • url: chaîne, adresse redirigée

Envoyer une redirection au client

1
2
HttpResponse.redirect(Integer statusCode,
    String url);

Paramètres d'appel :

  • statusCode: Entier, précisez le statut de retour du message de réponse, le statut accepté est : 301, 302, 307
  • url: chaîne, adresse redirigée

sendHeader

Envoyer le formatage uniquement http Dirigez-vous vers l'objet de flux donné

1
HttpResponse.sendHeader(Stream stm) async;

Paramètres d'appel :

  • stm: Stream, Spécifiez l'objet de flux pour recevoir les messages formatés

hasHeader

Vérifiez s'il existe un en-tête de message avec la valeur de clé spécifiée

1
Boolean HttpResponse.hasHeader(String name);

Paramètres d'appel :

  • name: String, spécifiez la valeur de la clé à vérifier

Résultat de retour :

  • Boolean, Renvoie si la valeur de clé existe

firstHeader

Interroger le premier en-tête de message de la valeur de clé spécifiée

1
String HttpResponse.firstHeader(String name);

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de la clé à interroger

Résultat de retour :

  • String, Renvoie la valeur correspondant à la valeur de la clé, si elle n'existe pas, renvoie undefined

allHeader

Interroger tous les en-têtes de message de la valeur de clé spécifiée

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

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de clé à interroger, passez une chaîne vide pour renvoyer le résultat de toutes les valeurs de clé

Résultat de retour :

  • NObject, Renvoie un tableau de toutes les valeurs correspondant à la valeur clé, si les données n'existent pas, renvoie null

addHeader

Ajouter un en-tête de message, l'ajout de données ne modifie pas l'en-tête de message de la valeur de clé existante

1
HttpResponse.addHeader(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez le dictionnaire de données clé-valeur à ajouter

Ajouter un ensemble d'en-têtes de message avec un nom spécifié, l'ajout de données ne modifie pas les en-têtes de message de la valeur de clé existante

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

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de clé à ajouter
  • values: Tableau, spécifiez un ensemble de données à ajouter

Ajouter un en-tête de message, l'ajout de données ne modifie pas l'en-tête de message de la valeur de clé existante

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

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de clé à ajouter
  • value: String, spécifiez les données à ajouter

setHeader

Définissez un en-tête de message, la définition des données modifiera la première valeur correspondant à la valeur de la clé et effacera les en-têtes de message restants avec la même valeur de clé

1
HttpResponse.setHeader(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez le dictionnaire de données clé-valeur à définir

Définissez un ensemble d'en-têtes de message avec un nom spécifié, les données de réglage modifieront la valeur correspondant à la valeur de clé et effaceront le reste des en-têtes de message avec la même valeur de clé

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

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de la clé à définir
  • values: Tableau, spécifiez un ensemble de données à définir

Définissez un en-tête de message, la définition des données modifiera la première valeur correspondant à la valeur de la clé et effacera les en-têtes de message restants avec la même valeur de clé

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

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de la clé à définir
  • value: String, spécifiez les données à définir

removeHeader

Supprimer tous les en-têtes de message de la valeur de clé spécifiée

1
HttpResponse.removeHeader(String name);

Paramètres d'appel :

  • name: chaîne, spécifiez la valeur de la clé à supprimer

read

Lire les données de la taille spécifiée à partir du flux, cette méthode est l'alias de la méthode correspondante du corps

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

Paramètres d'appel :

  • bytes: Entier, spécifiez la quantité de données à lire, la valeur par défaut est de lire un bloc de données de taille aléatoire, la taille des données lues dépend de l'appareil

Résultat de retour :

  • Buffer, Renvoie les données lues à partir du flux, s'il n'y a pas de données à lire ou si la connexion est interrompue, renvoie null

readAll

Lire toutes les données restantes du flux, cette méthode est un alias de la méthode correspondante du corps

1
Buffer HttpResponse.readAll() async;

Résultat de retour :

  • Buffer, Renvoie les données lues à partir du flux, s'il n'y a pas de données à lire ou si la connexion est interrompue, renvoie null

write

Ecrire les données données, cette méthode est l'alias de la méthode correspondante du corps

1
HttpResponse.write(Buffer data) async;

Paramètres d'appel :

  • data: Buffer, Étant donné les données à écrire

json

Écrire les données données en encodage JSON

1
Value HttpResponse.json(Value data);

Paramètres d'appel :

  • data: Valeur, étant donné les données à écrire

Résultat de retour :

  • Value, Cette méthode ne renverra pas de données

Analyser les données du message en codage JSON

1
Value HttpResponse.json();

Résultat de retour :

  • Value, Renvoie le résultat analysé

pack

par msgpack Encoder pour écrire les données données

1
Value HttpResponse.pack(Value data);

Paramètres d'appel :

  • data: Valeur, étant donné les données à écrire

Résultat de retour :

  • Value, Cette méthode ne renverra pas de données

par msgpack Encodage et analyse des données dans le message

1
Value HttpResponse.pack();

Résultat de retour :

  • Value, Renvoie le résultat analysé

end

Définir la fin du traitement du message en cours,Chain Le processeur ne poursuit pas les transactions suivantes

1
HttpResponse.end();

isEnded

Demander si le message actuel est terminé

1
Boolean HttpResponse.isEnded();

Résultat de retour :

  • Boolean, Renvoie vrai à la fin

clear

Effacer le contenu du message

1
HttpResponse.clear();

sendTo

Envoyer un message formaté à l'objet de flux donné

1
HttpResponse.sendTo(Stream stm) async;

Paramètres d'appel :

  • stm: Stream, Spécifiez l'objet de flux pour recevoir les messages formatés

readFrom

Lire le message formaté à partir de l'objet de flux de cache donné et analyser l'objet de remplissage

1
HttpResponse.readFrom(Stream stm) async;

Paramètres d'appel :

  • stm: Stream, Spécifiez l'objet de flux pour lire les messages formatés

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Objet natif]", l'objet peut être ré-implémenté selon ses propres caractéristiques

1
String HttpResponse.toString();

Résultat de retour :

  • String, Renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie la représentation au format JSON de l'objet, renvoie généralement une collection d'attributs lisibles définis par l'objet

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

Paramètres d'appel :

  • key: chaîne, inutilisé

Résultat de retour :

  • Value, Renvoie une valeur contenant JSON sérialisable
© Copyright 2012-2021 fibjs.org | Soutenez-nous