HttpIncomingStream
Overview
Implements an incoming stream of HTTP message (HttpIncomingRequestResponse). You will usually deal with the separate descendants HttpServerRequest or HttpClientResponse that descend from HttpIncomingRequestResponse.
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK.Http
- Ancestry: Stream | HttpIncomingStream
constructor
constructor(owner: HttpIncomingRequestResponse)
HttpIncomingStream(HttpIncomingRequestResponse owner)
init(_ owner: HttpIncomingRequestResponse)
Sub New(owner As HttpIncomingRequestResponse)
Parameters:
- owner:
CanRead
Gets a value indicating whether the current stream supports reading.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
ReadOnly Property CanRead() As Boolean
CanSeek
Gets a value indicating whether the current stream supports seeking.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
ReadOnly Property CanSeek() As Boolean
CanWrite
Gets a value indicating whether the current stream supports writing.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
ReadOnly Property CanWrite() As Boolean
Close
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
method Close
void Close()
func Close()
Sub Close()
Flush
Clears all buffers for this stream.
method Flush
void Flush()
func Flush()
Sub Flush()
FlushContent
method FlushContent: Boolean
Boolean FlushContent()
func FlushContent() -> Boolean
Function FlushContent() As Boolean
Length
Gets the length in bytes of the stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
ReadOnly Property Length() As Int64
Position
Gets or sets the position within the current stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Property Position() As Int64
Read
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
method Read(buffer: array of Byte; offset: Int32; size: Int32): Int32
Int32 Read(Byte[] buffer, Int32 offset, Int32 size)
func Read(_ buffer: Byte..., _ offset: Int32, _ size: Int32) -> Int32
Function Read(buffer As Byte(), offset As Int32, size As Int32) As Int32
Parameters:
- buffer:
- offset:
- size:
Seek
Sets the position within the current stream.
method Seek(offset: Int64; origin: SeekOrigin): Int64
Int64 Seek(Int64 offset, SeekOrigin origin)
func Seek(_ offset: Int64, _ origin: SeekOrigin) -> Int64
Function Seek(offset As Int64, origin As SeekOrigin) As Int64
Parameters:
- offset:
- origin:
SetLength
Sets the length of the current stream.
method SetLength(length: Int64)
void SetLength(Int64 length)
func SetLength(_ length: Int64)
Sub SetLength(length As Int64)
Parameters:
- length:
Write
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
method Write(buffer: array of Byte; offset: Int32; size: Int32)
void Write(Byte[] buffer, Int32 offset, Int32 size)
func Write(_ buffer: Byte..., _ offset: Int32, _ size: Int32)
Sub Write(buffer As Byte(), offset As Int32, size As Int32)
Parameters:
- buffer:
- offset:
- size:
CanRead
Gets a value indicating whether the current stream supports reading.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
ReadOnly Property CanRead() As Boolean
CanSeek
Gets a value indicating whether the current stream supports seeking.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
ReadOnly Property CanSeek() As Boolean
CanWrite
Gets a value indicating whether the current stream supports writing.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
ReadOnly Property CanWrite() As Boolean
Length
Gets the length in bytes of the stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
ReadOnly Property Length() As Int64
Position
Gets or sets the position within the current stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Property Position() As Int64
constructor
constructor(owner: HttpIncomingRequestResponse)
HttpIncomingStream(HttpIncomingRequestResponse owner)
init(_ owner: HttpIncomingRequestResponse)
Sub New(owner As HttpIncomingRequestResponse)
Parameters:
- owner:
Close
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
method Close
void Close()
func Close()
Sub Close()
Flush
Clears all buffers for this stream.
method Flush
void Flush()
func Flush()
Sub Flush()
FlushContent
method FlushContent: Boolean
Boolean FlushContent()
func FlushContent() -> Boolean
Function FlushContent() As Boolean
Read
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
method Read(buffer: array of Byte; offset: Int32; size: Int32): Int32
Int32 Read(Byte[] buffer, Int32 offset, Int32 size)
func Read(_ buffer: Byte..., _ offset: Int32, _ size: Int32) -> Int32
Function Read(buffer As Byte(), offset As Int32, size As Int32) As Int32
Parameters:
- buffer:
- offset:
- size:
Seek
Sets the position within the current stream.
method Seek(offset: Int64; origin: SeekOrigin): Int64
Int64 Seek(Int64 offset, SeekOrigin origin)
func Seek(_ offset: Int64, _ origin: SeekOrigin) -> Int64
Function Seek(offset As Int64, origin As SeekOrigin) As Int64
Parameters:
- offset:
- origin:
SetLength
Sets the length of the current stream.
method SetLength(length: Int64)
void SetLength(Int64 length)
func SetLength(_ length: Int64)
Sub SetLength(length As Int64)
Parameters:
- length:
Write
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
method Write(buffer: array of Byte; offset: Int32; size: Int32)
void Write(Byte[] buffer, Int32 offset, Int32 size)
func Write(_ buffer: Byte..., _ offset: Int32, _ size: Int32)
Sub Write(buffer As Byte(), offset As Int32, size As Int32)
Parameters:
- buffer:
- offset:
- size: