Objet objet intégré
  1. page de garde
  2. objets intégrés
  3. ObjetHttpMessage

ObjetHttpMessage

httpObjet de message de base

relation d'héritage

%0 object object toString() toJSON() Message Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() object->Message HttpMessage HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxHeaderSize maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() Message->HttpMessage HttpRequest HttpRequest HttpMessage->HttpRequest HttpResponse HttpResponse HttpMessage->HttpResponse

constante

TEXT

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

1
const HttpMessage.TEXT = 1;

BINARY

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

1
const HttpMessage.BINARY = 2;

propriétés des membres

protocol

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

1
String HttpMessage.protocol;

headers

HttpCollection, inclus dans le messagehttpConteneur pour les en-têtes de message, propriété en lecture seule

1
readonly HttpCollection HttpMessage.headers;

keepAlive

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

1
Boolean HttpMessage.keepAlive;

upgrade

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

1
Boolean HttpMessage.upgrade;

maxHeadersCount

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

1
Integer HttpMessage.maxHeadersCount;

maxHeaderSize

Entier, interrogez et définissez la longueur maximale de l'en-tête de requête, la valeur par défaut est 8192

1
Integer HttpMessage.maxHeaderSize;

maxBodySize

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

1
Integer HttpMessage.maxBodySize;

socket

Stream, Interroger la socket source de l'objet actuel

1
readonly Stream HttpMessage.socket;

value

String, le contenu de base du message

1
String HttpMessage.value;

params

NArray, les paramètres de base du message

1
readonly NArray HttpMessage.params;

type

Entier, type de message

1
Integer HttpMessage.type;

data

Valeur, interroge les données du message. Cet attribut renverra des données différentes en fonction du type de contenu. Lorsqu'il s'agit de texte, le texte sera renvoyé.jsonrevenir quandjson, sinon il renvoie du binaire

1
readonly Value HttpMessage.data;

body

SeekableStream, un objet flux contenant la partie données du message

1
SeekableStream HttpMessage.body;

length

Long : la longueur de la partie des données du message

1
readonly Long HttpMessage.length;

stream

Stream, l'objet flux lors de l'interrogation du message readFrom

1
readonly Stream HttpMessage.stream;

lastError

Chaîne, interroge et définit la dernière erreur de traitement du message

1
String HttpMessage.lastError;

fonction membre

hasHeader

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

1
Boolean HttpMessage.hasHeader(String name);

Paramètres d'appel :

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

Résultats de retour :

  • Boolean, renvoie si la valeur clé existe

firstHeader

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

1
String HttpMessage.firstHeader(String name);

Paramètres d'appel :

  • name: String, spécifiez la valeur clé à interroger

Résultats de retour :

  • String, renvoie la valeur correspondant à la valeur clé, si elle n'existe pas, renvoie undéfini

allHeader

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

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

Paramètres d'appel :

  • name: String, spécifiez la valeur clé à interroger, transmettez une chaîne vide pour renvoyer les résultats de toutes les valeurs clés

Résultats de retour :

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

addHeader

Ajoutez un en-tête de message, ajoutez des données et ne modifiez pas l'en-tête de message de la valeur clé existante

1
HttpMessage.addHeader(Object map);

Paramètres d'appel :

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

Ajoute un ensemble d'en-têtes avec le nom spécifié. L'ajout de données ne modifie pas les en-têtes des valeurs de clé existantes.

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

Paramètres d'appel :

  • name: String, spécifie la valeur clé à ajouter
  • values : Array, spécifie un ensemble de données à ajouter

Ajoutez un en-tête de message, ajoutez des données et ne modifiez pas l'en-tête de message de la valeur clé existante

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

Paramètres d'appel :

  • name: String, spécifie la valeur clé à ajouter
  • value: String, spécifiez les données à ajouter

setHeader

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

1
HttpMessage.setHeader(Object map);

Paramètres d'appel :

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

Définissez un ensemble d'en-têtes de message avec le nom spécifié. La définition des données modifiera la valeur correspondant à la valeur de clé et effacera les en-têtes de message restants avec la même valeur de clé.

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

Paramètres d'appel :

  • name: String, spécifiez la valeur clé à définir
  • values : Array, spécifie un ensemble de données à définir

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

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

Paramètres d'appel :

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

removeHeader

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

1
HttpMessage.removeHeader(String name);

Paramètres d'appel :

  • name: String, spécifie la valeur clé à supprimer

read

Lit des données de taille spécifiée à partir du flux.Cette méthode est un alias de la méthode correspondante de body.

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

Paramètres d'appel :

  • bytes : Nombre entier, spécifie la quantité de données à lire. La valeur par défaut est de lire des blocs de données de taille aléatoire. La taille des données lues dépend de l'appareil.

Résultats de retour :

  • Buffer, renvoie les données lues à partir du flux. S'il n'y a aucune donnée à lire ou si la connexion est interrompue, null est renvoyé.

readAll

Lit toutes les données restantes du flux.Cette méthode est un alias de la méthode correspondante de body.

1
Buffer HttpMessage.readAll() async;

Résultats de retour :

  • Buffer, renvoie les données lues à partir du flux. S'il n'y a aucune donnée à lire ou si la connexion est interrompue, null est renvoyé.

write

Écrivez les données données.Cette méthode est un alias de la méthode correspondante dans le corps.

1
HttpMessage.write(Buffer data) async;

Paramètres d'appel :

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

json

Écrit les données données en codage JSON

1
Value HttpMessage.json(Value data);

Paramètres d'appel :

  • data: Valeur, compte tenu des données à écrire

Résultats de retour :

  • Value, cette méthode ne renvoie pas de données

Analyser les données du message sous forme d'encodage JSON

1
Value HttpMessage.json();

Résultats de retour :

  • Value, renvoie le résultat analysé

pack

parmsgpackL'encodage écrit les données données

1
Value HttpMessage.pack(Value data);

Paramètres d'appel :

  • data: Valeur, compte tenu des données à écrire

Résultats de retour :

  • Value, cette méthode ne renvoie pas de données

parmsgpackEncodage et analyse des données dans le message

1
Value HttpMessage.pack();

Résultats de retour :

  • Value, renvoie le résultat analysé

end

Définir la fin du traitement du message en cours,ChainLe processeur ne poursuit pas les transactions ultérieures

1
HttpMessage.end();

isEnded

Demander si le message en cours est terminé

1
Boolean HttpMessage.isEnded();

Résultats de retour :

  • Boolean, renvoie vrai une fois terminé

clear

Contenu clair du message

1
HttpMessage.clear();

sendTo

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

1
HttpMessage.sendTo(Stream stm) async;

Paramètres d'appel :

  • stm:Stream, spécifie l'objet de flux qui reçoit le message formaté

readFrom

Lit le message formaté à partir de l'objet de flux de cache donné et analyse l'objet renseigné

1
HttpMessage.readFrom(Stream stm) async;

Paramètres d'appel :

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

toString

Renvoie la représentation sous forme de chaîne de l'objet. Généralement, "[Native Object]" est renvoyé. L'objet peut être réimplémenté en fonction de ses propres caractéristiques.

1
String HttpMessage.toString();

Résultats de retour :

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

toJSON

Renvoie une représentation au format JSON de l'objet, renvoyant généralement une collection de propriétés lisibles définies par l'objet.

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

Paramètres d'appel :

  • key: Chaîne, non utilisée

Résultats de retour :

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