njs/stream

Types

SendOption

pub type SendOption {
  SendOption(last: Bool, flush: Bool)
}

Constructors

```
SendOption(last: Bool, flush: Bool)
```

StreamData

</>

pub type StreamData {
  StreamString(s: String, last: Bool)
  StreamBuffer(b: buffer.Buffer, last: Bool)
}

Constructors

```
StreamString(s: String, last: Bool)
```

StreamBuffer(b: buffer.Buffer, last: Bool)

StreamEvent

</>

pub type StreamEvent {
  UpStringEvent
  DownStringEvent
  UpBufferEvent
  DownBufferEvent
}

Constructors

```
UpStringEvent
```
```
DownStringEvent
```
```
UpBufferEvent
```
```
DownBufferEvent
```

StreamSession

</>

pub type StreamSession

Values

allow

</>

pub fn allow(session: StreamSession) -> Nil

decline

</>

pub fn decline(session: StreamSession) -> Nil

deny

</>

pub fn deny(session: StreamSession) -> Nil

done

</>

pub fn done(session: StreamSession) -> Nil

done_code

</>

pub fn done_code(session: StreamSession, code: Int) -> Nil

error

</>

pub fn error(session: StreamSession, message: String) -> Nil

log

</>

pub fn log(session: StreamSession, message: String) -> Nil

off

</>

pub fn off(session: StreamSession, event: StreamEvent) -> Nil

on

</>

pub fn on(
  session: StreamSession,
  event: StreamEvent,
  callback cb: fn(StreamData) -> Nil,
) -> Nil

raw_variables

</>

pub fn raw_variables(session: StreamSession) -> ngx.JsObject

remote_address

</>

pub fn remote_address(session: StreamSession) -> String

send

</>

pub fn send(
  session s: StreamSession,
  data d: a,
  option o: SendOption,
) -> Nil

send_downstream

</>

pub fn send_downstream(
  session s: StreamSession,
  data d: a,
  option o: SendOption,
) -> Nil

send_upstream

</>

pub fn send_upstream(
  session s: StreamSession,
  data d: a,
  option o: SendOption,
) -> Nil

set_return_value

</>

pub fn set_return_value(
  session: StreamSession,
  return_value: promise.Promise(a),
) -> promise.Promise(Nil)

status

</>

pub fn status(session: StreamSession) -> Int

variables

</>

pub fn variables(session: StreamSession) -> ngx.JsObject

warn

</>

pub fn warn(session: StreamSession, message: String) -> Nil