Back to Adaptive Vision Library website

You are here: Start » Function Reference » System » HTTP » Http_SendRequest_GET_ByteBuffer

Http_SendRequest_GET_ByteBuffer


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Sends a GET request to server and receives a binary answer.

Syntax

C++
C#
 
void avl::Http_SendRequest_GET_ByteBuffer
(
	const atl::String& inUrl,
	const atl::Array<atl::String>& inFields,
	const atl::Array<atl::String>& inFieldsData,
	atl::Conditional<avl::ByteBuffer>& outAnswer,
	int& outResponseCode
)

Parameters

Name Type Default Description
inUrl const String& URL of request. Without parameters.
inFields const Array<String>& Request data to send. It will be automatically encoded.
inFieldsData const Array<String>& Request data to send. It will be automatically encoded.
outAnswer Conditional<ByteBuffer>& Answer as binary byte buffer.
outResponseCode int& Answer code. Typically 200 for OK.

Description

Filter sends a GET request to the server then waits for the sever answer. Filter can be used to download files from the remote server.

Examples

Filter executed with parameters:

  • inUrl = http://localhost/test
  • inFields = ["param1", "param2"]
  • inFieldsData = ["1", "2"]

Request sent to the server:

GET /test?param1=1&param2=2 HTTP/1.1
Host: localhost
User-Agent: Adaptive Vision/1.0
Accept: */*

Errors

List of possible exceptions:

Error type Description
DomainError Different size of inFields and inFieldsData in Http_SendRequest_GET_ByteBuffer.
DomainError Empty inUrl in Http_SendRequest_GET_ByteBuffer.
DomainError Invalid inUrl in Http_SendRequest_GET_ByteBuffer.
DomainError Secured HTTPS connection is not supported Http_SendRequest_GET_ByteBuffer.

See Also