IStream Interface Reference

Provides access to the FPGA Manager Streaming API More...

Public Member Functions
int	Read (byte[] buffer)
	Read data from stream into buffer More...
int	Read (byte[] buffer, int offset, int length)
	Read data from stream into buffer More...
int	Read (IntPtr buffer, int offset, int length)
	Read data from stream into buffer More...
Task< AsyncStreamTransferResult >	ReadAsync (byte[] buffer)
	Read data from stream into buffer asynchronously (non-blocking) More...
Task< AsyncStreamTransferResult >	ReadAsync (byte[] buffer, int offset, int length)
	Read data from stream into buffer asynchronously (non-blocking) More...
Task< AsyncStreamPtrTransferResult >	ReadAsync (IntPtr buffer, int offset, int length)
	Read data from stream into buffer asynchronously (non-blocking) More...
int	Write (byte[] buffer)
	Write data from buffer to stream More...
int	Write (byte[] buffer, int offset, int length)
	Write data from buffer to stream More...
int	Write (IntPtr buffer, int offset, int length)
	Write data from buffer to stream More...
Task< AsyncStreamTransferResult >	WriteAsync (byte[] buffer)
	Write data from buffer to stream asynchronously (non-blocking) More...
Task< AsyncStreamTransferResult >	WriteAsync (byte[] buffer, int offset, int length)
	Write data from buffer to stream asynchronously (non-blocking) More...
Task< AsyncStreamPtrTransferResult >	WriteAsync (IntPtr buffer, int offset, int length)
	Write data from buffer to stream asynchronously (non-blocking) More...
void	Flush ()
	Flushes the inbound buffer More...
int	Read (Span< byte > data)
	Read data from stream into buffer More...
int	Read (Memory< byte > data)
	Read data from stream into buffer More...
Task< AsyncStreamMemRdTransferResult >	ReadAsync (Memory< byte > buffer)
	Read data from stream into buffer asynchronously (non-blocking) More...
int	Write (ReadOnlySpan< byte > data)
	Write data from buffer to stream More...
int	Write (ReadOnlyMemory< byte > data)
	Write data from buffer to stream More...
Task< AsyncStreamMemWrTransferResult >	WriteAsync (ReadOnlyMemory< byte > buffer)
	Write data from buffer to stream asynchronously (non-blocking) More...

Detailed Description

Provides access to the FPGA Manager Streaming API

Member Function Documentation

Flush()

void Flush

(

)

Flushes the inbound buffer

Read() [1/5]

int Read

(

byte []

buffer

)

Read data from stream into buffer

Parameters

buffer

Buffer where the data is copied to

Returns

Number of bytes that have been transferred

Read() [2/5]

int Read	(	byte []	buffer,
		int	offset,
		int	length
	)

Read data from stream into buffer

Parameters

buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

Number of bytes that have been transferred

Read() [3/5]

int Read	(	IntPtr	buffer,
		int	offset,
		int	length
	)

Read data from stream into buffer

Parameters

buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

Number of bytes that have been transferred

Read() [4/5]

int Read

(

Span< byte >

data

)

Read data from stream into buffer

requires .NET standard 2.1

Parameters

data	Buffer where the data is copied to

Returns

Number of bytes that have been transferred

Read() [5/5]

int Read

(

Memory< byte >

data

)

Read data from stream into buffer

requires .NET standard 2.1

Parameters

data	Buffer where the data is copied to

Returns

Number of bytes that have been transferred

ReadAsync() [1/4]

Task<AsyncStreamTransferResult> ReadAsync

(

byte []

buffer

)

Read data from stream into buffer asynchronously (non-blocking)

Parameters

buffer

Buffer where the data is copied to

Returns

TAP Task

ReadAsync() [2/4]

Task<AsyncStreamTransferResult> ReadAsync	(	byte []	buffer,
		int	offset,
		int	length
	)

Read data from stream into buffer asynchronously (non-blocking)

Parameters

buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

ReadAsync() [3/4]

Task<AsyncStreamPtrTransferResult> ReadAsync	(	IntPtr	buffer,
		int	offset,
		int	length
	)

Read data from stream into buffer asynchronously (non-blocking)

Parameters

buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

ReadAsync() [4/4]

Task<AsyncStreamMemRdTransferResult> ReadAsync

(

Memory< byte >

buffer

)

Read data from stream into buffer asynchronously (non-blocking)

requires .NET standard 2.1

Parameters

buffer

Buffer where the data is copied to

Returns

TAP Task

Write() [1/5]

int Write

(

byte []

buffer

)

Write data from buffer to stream

Parameters

buffer

Buffer where the data is copied from

Returns

Number of bytes that have been transferred

Write() [2/5]

int Write	(	byte []	buffer,
		int	offset,
		int	length
	)

Write data from buffer to stream

Parameters

buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

Number of bytes that have been transferred

Write() [3/5]

int Write	(	IntPtr	buffer,
		int	offset,
		int	length
	)

Write data from buffer to stream

Parameters

buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

Number of bytes that have been transferred

Write() [4/5]

int Write

(

ReadOnlySpan< byte >

data

)

Write data from buffer to stream

requires .NET standard 2.1

Parameters

data	Buffer where the data is copied from

Returns

Number of bytes that have been transferred

Write() [5/5]

int Write

(

ReadOnlyMemory< byte >

data

)

Write data from buffer to stream

requires .NET standard 2.1

Parameters

data	Buffer where the data is copied from

Returns

Number of bytes that have been transferred

WriteAsync() [1/4]

Task<AsyncStreamTransferResult> WriteAsync

(

byte []

buffer

)

Write data from buffer to stream asynchronously (non-blocking)

Parameters

buffer

Buffer where the data is copied from

Returns

TAP Task

WriteAsync() [2/4]

Task<AsyncStreamTransferResult> WriteAsync	(	byte []	buffer,
		int	offset,
		int	length
	)

Write data from buffer to stream asynchronously (non-blocking)

Parameters

buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

WriteAsync() [3/4]

Task<AsyncStreamPtrTransferResult> WriteAsync	(	IntPtr	buffer,
		int	offset,
		int	length
	)

Write data from buffer to stream asynchronously (non-blocking)

Parameters

buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

WriteAsync() [4/4]

Task<AsyncStreamMemWrTransferResult> WriteAsync

(

ReadOnlyMemory< byte >

buffer

)

Write data from buffer to stream asynchronously (non-blocking)

requires .NET standard 2.1

Parameters

buffer

Buffer where the data is copied from

Returns

TAP Task

---

The documentation for this interface was generated from the following file:

• C:/Git/Ip/en_mgr_sw/Projects/Win7/CsApi/IStream.cs