matlab.net.http.io.GenericConsumer 클래스

패키지: matlab.net.http.io
슈퍼클래스: matlab.net.http.io.ContentConsumer

HTTP 메시지 내 여러 콘텐츠 유형의 소비자

설명

서버가 어떤 콘텐츠 유형을 반환할지 사전에 예상할 수 없는 경우 여러 콘텐츠 유형의 스트리밍을 처리하기 위해 이 소비자를 사용하십시오.

matlab.net.http.io.GenericConsumer 클래스는 handle 클래스입니다.

생성

설명

consumer = GenericConsumer는 디폴트 소비자를 사용하여 GenericConsumer를 생성합니다.

consumer = GenericConsumer(types,consumer)는 지정된 types를 처리하는 GenericConsumer를 이에 대응하는 consumer를 사용하여 생성합니다. types1,consumer1,...,typesN,consumerN과 같이 여러 개의 인수 쌍을 임의의 순서로 지정할 수 있습니다. MATLAB^®은 표시된 순서대로 types를 검색하여 일치하는 첫 번째 값을 사용합니다. 지정된 유형에 일치하는 값이 없으면 MATLAB은 해당 유형의 디폴트 소비자 세트를 사용합니다.

consumer = GenericConsumer(puthandle)은 ContentConsumer의 putData 메서드 호출 시마다 puthandle이 지정하는 함수를 호출하는 ContentConsumer를 생성합니다.

입력 인수

types — 콘텐츠 유형

string형 배열 | 문자형 벡터 | 문자형 벡터로 구성된 셀형 배열

콘텐츠 유형으로, string형 배열, 문자형 벡터 또는 문자형 벡터로 구성된 셀형 배열로 지정됩니다. types는 "type/subtype" 구문을 사용하여 콘텐츠 유형을 지정합니다.

types의 각 요소에 있는 유형 구성요소와 하위유형 구성요소는 응답의 ContentTypeField의 유형/하위유형과 일치하는 정규 표현식으로 처리되고, 이에 더해 유형 또는 하위유형에 별 하나('*')를 사용하면 모든 유형 또는 하위유형과 일치하게 되며, 모든 검색은 string형의 시작 부분과 끝 부분 모두에 적용됩니다. 예를 들면 다음과 같습니다.

유형/하위유형	일치 항목
text/*	'text' 유형 및 모든 하위유형
*/.*json.*	하위유형이 'json'을 포함하는 모든 유형
*/.*json	하위유형이 'json'으로 끝나는 모든 유형
*/*	모든 유형 및 모든 하위유형

하위유형이 '*'라면 뒷부분의 '/*'는 생략해도 됩니다. 즉, text는 'text/*'와 동일합니다.

types는 표시되는 순서대로 검색되고, 일치하는 첫 번째 결과가 사용됩니다. 지정된 유형에 일치하는 결과가 없으면 다음과 같은 순서대로 해당 유형의 디폴트 소비자 세트가 사용됩니다.

유형/하위유형	디폴트 소비자
multipart/*	MultipartConsumer
image/*	ImageConsumer
.*/.*json.*	JSONConsumer
*/*	StringConsumer
*/*	BinaryConsumer

StringConsumer와 BinaryConsumer 둘 다 어느 유형에도 사용할 수 있지만, StringConsumer는 문자 집합을 확인할 수 있는 유형, 즉, text/*로 지정된 유형, 문자 집합 특성을 갖는 유형 또는 "application/xml" 및 "application/javascript"와 같이 MATLAB이 문자 기반임을 인식할 수 있는 유형만을 수신할 수 있습니다. StringConsumer가 거부한 유형은 BinaryConsumer가 받아서 변환되지 않은 페이로드를 Response.Body.Data에 uint8 벡터로 저장합니다.

이 소비자가 이와 같은 검색 조건에 따라 일치하는 대리자를 선택할 때 대리자의 initialize 메서드를 호출하여 대리자가 페이로드를 수신하는지 여부를 확인합니다. 대리자가 페이로드를 수신하지 않아 메서드가 false를 반환하면 이 소비자는 목록에서 계속해서 일치하는 다음 대리자를 검색합니다.

consumer — 콘텐츠 소비자

matlab.net.http.io.ContentConsumer | 함수 핸들

콘텐츠 소비자로, 지정된 유형 중 하나를 처리할 수 있는 matlab.net.http.io.ContentConsumer 객체로 지정되거나 이러한 유형을 처리할 수 있는 ContentConsumer를 반환하는 함수의 핸들로 지정됩니다.

puthandle — putData 함수

함수 핸들

다음과 같은 ContentConsumer.putData 구문을 갖는 함수의 핸들입니다.

[length,stop] = putData(data)

여기서 data는 uint8형 배열이고 length는 이 배열의 길이입니다.

서버로부터 반환되는 데이터의 유형을 알고 있는 경우, 서버로부터 수신되는 모든 입력을 함수 하나로 처리하려면 이 구문을 사용하십시오. 이 함수에는 ResponseMessage나 이 소비자에 대한 다른 정보에 대한 액세스 권한이 없습니다.

속성

퍼블릭 속성

AllocationLength — 제안 버퍼 크기

uint64

제안 버퍼 크기로, uint64로 지정됩니다. MATLAB은 AllocationLength를 putData로 전달된 데이터의 예상 버퍼 크기로 설정합니다. 실제 크기는 이보다 작거나 클 수 있습니다. 성능을 개선하려면 소비자는 이 값을 사용하여 데이터를 처리할 공간을 사전할당할 수 있습니다.

MATLAB은 서브클래스의 편의를 위해 start 메서드를 호출하기 전에 먼저 이 속성을 설정합니다.

특성:

GetAccess	public
SetAccess	public

ContentLength — 페이로드의 예상 길이

uint64 | 비어 있음

페이로드의 예상 길이로, uint64로 지정됩니다. 이 속성은 일반적으로 Header 속성의 matlab.net.http.field.ContentLengthField의 Value 속성입니다.

ContentLength가 비어 있다면 길이를 알 수 없다는 의미입니다. putData(uint8.empty)가 호출되면 페이로드가 종료됩니다.

MATLAB은 데이터의 길이를 알면 좋은 서브클래스에 대해 편의를 위해 initialize를 호출하기 전에 먼저 이 속성을 설정합니다.

이 ContentConsumer가 최상위 소비자의 대리자인 경우, ContentLength의 값이 최상위 소비자의 ContentLength 값과 다를 수 있습니다.

예: someData의 type이 uint8인 numel(someData)

특성:

GetAccess	public
SetAccess	public

ContentType — 페이로드의 미디어 형식

matlab.net.http.MediaType | 비어 있음

페이로드의 미디어 형식으로, matlab.net.http.MediaType 객체로 지정됩니다. 이 속성은 일반적으로 Header 속성의 matlab.net.http.field.ContentTypeField의 Value 속성입니다. ContentType 속성이 비어 있으면 ContentTypeField가 비어 있거나 존재하지 않는 것입니다.

MATLAB은 MediaType을 검토하고자 하는 서브클래스에 대해 편의를 위해 initialize를 호출하기 전에 먼저 이 속성을 설정합니다. 서브클래스가 데이터를 보고 데이터가 다른 MediaType이라고 판단하는 경우에는 이 속성을 설정할 수 있습니다.

전송이 끝나면 MATLAB이 이 값을 Response.Body.ContentType 속성에 복사합니다.

예: 'application/octet-stream'

특성:

GetAccess	public
SetAccess	public

Header — 현재 처리되고 있는 페이로드의 헤더

matlab.net.http.HeaderField

현재 처리되고 있는 페이로드의 헤더로, matlab.net.http.HeaderField 객체로 지정됩니다.

소비자는 전송받고 있는 페이로드를 처리할 방법을 결정할 때 이 헤더를 사용합니다. 최상위 소비자의 경우, 이 값은 Response.Header와 동일합니다. 대리자의 경우에는 이 값이 다를 수 있습니다. 예를 들어, MultipartConsumer가 처리하는 multipart 메시지에서 이 값은 이 대리자가 처리하는 파트의 헤더가 됩니다. 대리자는 여전히 원본 메시지의 헤더를 Response.Header에서 검토할 수 있습니다.

MATLAB은 서브클래스의 편의를 위해 initialize를 호출하기 전에 먼저 이 속성을 설정합니다.

특성:

GetAccess	public
SetAccess	public

Request — 전송된 완전한 RequestMessage

matlab.net.http.RequestMessage

전송된 완전한 RequestMessage로, matlab.net.http.RequestMessage 객체로 지정됩니다. 모든 리디렉션이 끝난 뒤의 최종 RequestMessage이자 send 메서드의 completedrequest 반환 값입니다.

MATLAB은 서브클래스의 편의를 위해 initialize를 호출하기 전에 먼저 이 속성을 설정합니다.

특성:

GetAccess	public
SetAccess	public

Response — 처리되고 있는 ResponseMessage

matlab.net.http.ResponseMessage

처리되고 있는 ResponseMessage로, matlab.net.http.ResponseMessage 객체로 지정됩니다.

MATLAB은 initialize를 호출하기 전에 먼저 Response 속성을 설정합니다. 이 값은 헤더 수신 이후이고 페이로드 수신 이전의 ResponseMessage입니다. 응답 메시지의 처리가 시작될 때(또는 multipart 메시지 중 한 파트의 시작 부분에서), ResponseMesssage.Body 속성은 Data 속성과 Payload 속성이 비어 있는 MessageBody 객체입니다. 소비자는 수신된 데이터를 저장하기 위해 데이터 전송 중에 Response 속성과 MessageBody.Data 속성을 수정할 수 있습니다. 일반적으로 데이터를 처리하고 저장하는 소비자는 Response.Body.Data를 처리된 페이로드로 설정하지만, 이는 필수적인 것은 아닙니다. 전송이 완료되면 MATLAB은 이 Response를 send의 호출자에게 반환합니다. Header나 StatusLine 같은 다른 Response 속성을 변경하면 send의 호출자에게 반환되기 때문에 소비자는 이러한 속성을 수정하면 안 됩니다.

Response.Body.Payload 속성은 전송 중에 비어 있으며, 소비자가 이를 수정하려고 시도하면 안 됩니다. HTTPOptions.SavePayload 속성이 설정된 경우, MATLAB은 메시지 또는 파트의 전송이 종료되었을 때(putData(uint8.empty)에 대한 호출 후) 또는 예외가 발생했을 때 Payload를 수신된 페이로드로 설정합니다.

메시지 처리 중에 소비자에 예외가 발생한 경우, MATLAB은 HTTPException 객체를 발생시킵니다. History 속성은 이 Response 값을 포함합니다.

소비자가 multipart 메시지의 한 파트를 처리하고 있는 대리자인 경우, Response.Header는 전체 메시지의 헤더를 포함하고, 각 파트의 ContentConsumer가 호출되기 전에 Response.Body의 Payload 속성과 Data 속성이 지워집니다. 각 파트가 완료되면 원본 응답의 Body.Data에 들어 있는 ResponseMessage 객체로 구성된 배열의 끝에 이 객체의 Header와 이 속성의 Body를 포함하는 새 ResponseMessage가 추가됩니다. 다음 대리자는 이전 대리자의 MessageBody가 아닌 빈 MessageBody를 포함하는 새 Response를 가지게 됩니다.

특성:

GetAccess	public
SetAccess	public
Dependent	true

URI — 처리되고 있는 요청의 대상

matlab.net.URI

처리되고 있는 요청의 대상으로, matlab.net.URI 객체로 지정됩니다. 이 값은 send에 의해 결정된 원본 대상 URI입니다. 리디렉션이 이루어진 뒤의 프록시 URI나 최종 URI가 아닙니다.

MATLAB은 서브클래스의 편의를 위해 initialize를 호출하기 전에 먼저 이 속성을 설정합니다.

특성:

GetAccess	public
SetAccess	public

보호 속성

PutMethod — putData 메서드

함수 핸들 | []

대리자의 putData 메서드로, 함수 핸들로 지정되거나 CurrentDelegate가 설정되어 있는 경우 []로 지정됩니다.

이 속성은 delegateTo에 의해 설정됩니다. 서브클래스가 대리자에게 데이터를 전송하거나, 데이터의 대리자 부분을 종료하기 위해 uint8.empty를 전송하려면 자신의 putData 메서드에서 다음과 같이 이 함수를 호출해야 합니다.

[len, stop] = obj.PutMethod(data);

메시지를 종료하기 위해 위와 같이 대리자에 대한 호출을 수행한 후, 메시지의 끝에서 서브클래스는 PutMethod를 비어 있도록 설정하고 자신의 슈퍼클래스의 putData(uint8.empty)를 호출하여 이 클래스가 메시지가 종료되었다는 사실을 인식하게 만들어야 합니다. 이 putData 호출은 PutMethod를 빈 값으로 남겨 두거나 생성자에게 전달된 puthandle 인수로 설정합니다.

특성:

GetAccess	protected
SetAccess	protected
Dependent	true

AppendFcn — 데이터를 더 추가하기 위해 putData가 호출하는 함수

함수 핸들

함수로, 데이터를 더 추가하기 위해 putData 메서드가 호출하는 함수의 함수 핸들로 지정됩니다. 이 클래스의 putData 메서드는 data 인수에서 수신하는 데이터를 응답 메시지의 기존 데이터에 추가하기 위해 AppendFcn 함수를 호출합니다. 이 함수는 다음과 같은 시그니처를 가져야 합니다.

AppendFcn(consumer,newdata)

여기서 newdata는 consumer.Response.Body.Data의 배열에 추가될 데이터입니다. 이 메서드는 Data의 새 길이를 반영하도록 consumer.CurrentLength를 업데이트하는 역할을 담당합니다. newdata가 비어 있다는 것은 스트림이 끝났다는 것을 나타내는데, 이 경우 이 함수는 Response.Body.Data를 최종 값으로 업데이트해야 합니다.

이 속성이 비어 있으면 디폴트 동작은 내부 함수를 사용하여 Data를 horzcat 함수를 지원하는 임의 값으로 구성된 배열로 처리합니다. 공간을 사전할당하여 newdata를 효율적으로 추가하며, CurrentLength가 저장되는 데이터의 실제 길이가 되도록 유지합니다. 메시지의 끝에서 Response.Body.Data를 CurrentLength에 맞게 잘라냅니다.

이 추가하는 절차에 horzcat이 적절하지 않은 경우 서브클래스가 이 속성을 변경할 수 있습니다. 예를 들어, StringConsumer가 string형 스칼라를 빌드하면 horzcat 함수 대신 plus 함수를 사용하여 해당 string형에 추가합니다.

데이터 추가를 위해 ContentConsumer.putData를 호출하지 않거나 데이터를 추가할 때 horzcat의 동작으로 충족되는 서브클래스는 이 속성을 무시할 수 있습니다.

예: @customAppend가 소비자에 의해 정의되는 @customAppend

특성:

GetAccess	protected
SetAccess	protected

CurrentDelegate — 이 소비자가 위임하는 대상 ContentConsumer

matlab.net.http.io.ContentConsumer | []

이 소비자가 위임하는 대상 ContentConsumer로, matlab.net.http.io.ContentConsumer 객체로 지정됩니다. 호출하는 소비자(위임 주체)의 delegateTo 메서드가 CurrentDelegate 속성을 설정합니다. 현재 위임이 없는 경우, 이 값은 []이 됩니다.

MATLAB은 initialize를 호출하기 전에 CurrentDelegate를 []로 설정합니다.

특성:

GetAccess	protected
SetAccess	protected

CurrentLength — 현재 Response.Body.Data에 있는 데이터의 길이

uint64.empty (디폴트 값) | uint64

현재 Response.Body.Data 속성에 있는 데이터의 길이로, uint64로 지정됩니다.

이 속성은 Response.Body.Data가 현재 저장된 실제 데이터보다 큰 크기로 사전할당된 경우 저장된 데이터의 길이를 나타내기 위해 사용됩니다. 이 속성이 비어 있으면 Response.Body.Data 전체에 저장된 데이터를 포함하고 있거나 특정 ContentConsumer 서브클래스가 데이터를 Response.Body.Data에 저장하는 것 이외의 방법으로 데이터를 삭제하고 있음을 의미합니다.

이 속성은 AppendFcn 속성이 비어 있으면 이 기본 클래스의 putData 메서드에 의해 사용되고 설정됩니다. 이는 putData를 호출하며, 이미 저장되어 있는 데이터 및/또는 Response.Body.Data에서 결과를 유지하는 AppendFcn의 구현을 검토하는 서브클래스를 위한 것입니다.

putData를 사용하는 서브클래스는 이 속성을 사용하여 데이터가 저장되어 있는 버퍼의 위치를 재설정할 수도 있습니다. 예를 들어, 디폴트 AppendFcn 함수가 사용된 경우, putData 호출 시마다 Response.Body.Data 전체를 처리하는 서브클래스는 더 이상 원본 데이터가 필요하지 않으므로, 다음번 putData 호출 시 버퍼를 새 데이터로 덮어쓰도록 CurrentLength 속성을 1로 재설정할 수 있습니다. 버퍼에서 새 데이터 끝을 지나 존재하는 요소는 지울 필요가 없습니다.

putData를 호출하지 않는 서브클래스는 이 속성을 사용하여 자체 데이터를 추적하거나 설정하지 않은 상태로(빈 상태로) 둘 수 있습니다. MATLAB은 여기에 설정될 수 있는 값에 제약을 두지 않으며, 디폴트 AppendFcn이 다음 데이터 버퍼를 저장할 장소와 메시지 끝에서 잘라낼 데이터의 부분을 결정하는 용도 이외로는 이 속성을 사용하지 않습니다. putData(uint8.empty)를 마지막으로 호출하기 전에 이 속성을 빈 값으로 설정하면 데이터 잘림을 방지할 수 있습니다.

MATLAB은 매번 initialize를 호출하기 전에 이 속성을 빈 값으로 설정합니다.

특성:

GetAccess	protected
SetAccess	protected

MyDelegator — 이 소비자에게 위임된 ContentConsumer

matlab.net.http.io.ContentConsumer | 비어 있음

이 소비자에게 위임된 ContentConsumer로, matlab.net.http.io.ContentConsumer 객체로 지정됩니다. 이 소비자가 다른 소비자(예: GenericConsumer 또는 MultipartConsumer)가 호출한 대리자인 경우, 이 소비자는 호출하는 소비자가 됩니다. send 호출 시 지정된 최상위 소비자에서는 빈 값입니다.

예를 들어 자신에게 어떤 소비자가 위임되었는지 확인하기 위한 목적으로, 대리자는 이 속성을 사용하여 위임 주체의 속성에 액세스할 수 있습니다.

특성:

GetAccess	protected
SetAccess	protected

메서드

퍼블릭 메서드

initialize	새 HTTP 페이로드에 대한 소비자 준비하기
start	GenericConsumer로 데이터 전송 시작
putData	GenericConsumer에 대한 다음 데이터 버퍼 저장
delegateTo	다른 소비자에게 위임

세부 정보

클래스 계층 구조

버전 내역

R2018a에 개발됨

참고 항목

ContentConsumer | RequestMessage | ResponseMessage | ContentTypeField | FileProvider | fopen