@haxall/haxall
    Preparing search index...

    Class WebReq

    WebReq encapsulates a web request.

    See pod doc.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    absUri compare cookies equals form hash headers in isGet isImmutable isPost locales method mod modBase modRel parseMultiPartForm remoteAddr remotePort session socketOptions stash toImmutable toStr trap typeof uri version with echo make

    Constructors

    Properties

    type$: Type

    Methods

    • The absolute request URI including the full authority and the query string. Also see uri, modBase, and modRel. This method is equivalent to:

      "http://" + headers["Host"] + uri

      Examples:

      http://www.foo.com/a/b/c
      http://www.foo.com/a?q=bar

      Returns Uri

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that  =>  0
      this > that   =>  >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3)  =>  1
      8.compare(8)  =>  0
      3 <=> 8       =>  -1  // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Map of cookie values keyed by cookie name. The cookies map is readonly and case insensitive.

      Returns Map<string, string>

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Get the key/value pairs of the form data. If the request content type is "application/x-www-form-urlencoded", then the first time this method is called the request content is read and parsed using sys::Uri.decodeQuery. If the content type is not "application/x-www-form-urlencoded" this method returns null.

      Returns Map<string, string>

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Map of HTTP request headers. The headers map is readonly and case insensitive (see sys::Map.caseInsensitive).

      Examples:

      req.headers["Accept-Language"]

      Returns Map<string, string>

    • Get the stream to read request body. See WebUtil.makeContentInStream to check under which conditions request content is available. If request content is not available, then throw an exception.

      If the client specified the "Expect: 100-continue" header, then the first access of the request input stream will automatically send the client a 100 Continue response.

      Returns InStream

    • Return if the method is GET

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Return if the method is POST

      Returns boolean

    • Get the accepted locales for this request based on the "Accept-Language" HTTP header. List is sorted by preference, where locales.first is best, and locales.last is worst. This list is guarenteed to contain Locale("en").

      Returns List<Locale>

    • The HTTP request method in uppercase. Example: GET, POST, PUT.

      Returns string

    • Get the WebMod which is currently responsible for processing this request.

      Returns WebMod

    • Get the WebMod which is currently responsible for processing this request.

      Parameters

      Returns void

    • Base URI of the current WebMod. This Uri always ends in a slash. This is the URI used to route to the WebMod itself. The remainder of uri is stored in modRel so that the following always holds true (with exception of a trailing slash):

      modBase + modRel == uri

      For example if the current WebMod is mounted as /mod then:

      uri          modBase   modRel
      ----------   -------   -------
      `/mod`       `/mod/`   ``
      `/mod/`      `/mod/`   ``
      `/mod?q`     `/mod/`   `?q`
      `/mod/a`     `/mod/`   `a`
      `/mod/a/b`   `/mod/`   `a/b`

      Returns Uri

    • Base URI of the current WebMod. This Uri always ends in a slash. This is the URI used to route to the WebMod itself. The remainder of uri is stored in modRel so that the following always holds true (with exception of a trailing slash):

      modBase + modRel == uri

      For example if the current WebMod is mounted as /mod then:

      uri          modBase   modRel
      ----------   -------   -------
      `/mod`       `/mod/`   ``
      `/mod/`      `/mod/`   ``
      `/mod?q`     `/mod/`   `?q`
      `/mod/a`     `/mod/`   `a`
      `/mod/a/b`   `/mod/`   `a/b`

      Parameters

      Returns void

    • WebMod relative part of the URI - see modBase.

      Returns Uri

    • Given a web request:

      1. check that the content-type is form-data
      2. get the boundary string
      3. invoke callback for each part (see WebUtil.parseMultiPart)

      For each part in the stream call the given callback function with the part's form name, headers, and an input stream used to read the part's body.

      Parameters

      • cb: (arg0: string, arg1: InStream, arg2: Map<string, string>) => void

      Returns void

    • Get the IP host address of the client socket making this request.

      Returns IpAddr

    • Get the IP port of the client socket making this request.

      Returns number

    • Get the session associated with this browser "connection". The session must be accessed the first time before the response is committed.

      Returns WebSession

    • Access to socket options for this request.

      Returns SocketOptions

    • Stash allows you to stash objects on the WebReq object in order to pass data b/w Weblets while processing this request.

      Returns Map<string, JsObj>

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x()      a.trap("x", null)
      a->x = b    a.trap("x", [b])
      a->x(b)     a.trap("x", [b])
      a->x(b, c)  a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • The request URI including the query string relative to this authority. Also see absUri, modBase, and modRel.

      Examples:

      /a/b/c
      /a?q=bar

      Returns Uri

    • The HTTP version of the request.

      Returns Version

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Parameters

      • ...args: unknown[]

      Returns WebReq

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods