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

네임스페이스: matlab.net.http.io
슈퍼클래스: matlab.net.http.io.ContentConsumer

HTTP 메시지 내 파일의 소비자

페이지 내 모두 확장

설명

FileConsumer 클래스는 웹 서비스로부터 파일을 다운로드하거나 웹으로부터 수신된 데이터를 파일에 저장하는 편리한 방법입니다. 사용자는 파일의 이름을 지정하거나, MATLAB®이 서버로부터 전송된 정보의 이름이나 URI에 포함된 파일의 이름을 보고 이름을 결정하도록 할 수 있습니다.

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

생성

설명

consumer = FileConsumer(filename,permission,machineformat,encoding)은 서버로부터 수신된 응답의 페이로드를 사용하여 파일을 생성하거나 덮어쓰는 FileConsumer를 생성합니다. 파라미터는 fopen 함수의 파라미터와 동일한 의미를 가지며, 모든 파라미터는 선택 사항입니다.

consumer = FileConsumer(FID)는 FileIdentifier 속성을 FID로 설정하고 이 파일에 데이터를 씁니다. FID는 사용자가 쓰기를 수행하기 위해 연 파일의 식별자가 되어야 합니다. MATLAB은 파일의 현재 위치 표시자에 데이터를 쓰므로 예를 들어 사용자가 'a+' 권한을 이용하여 기존 파일을 열면 MATLAB이 이 파일에 데이터를 추가합니다. 전송이 완료되면 MATLAB은 파일 끝부분에 위치 표시자를 두며, 파일을 닫지 않습니다.

입력 인수

모두 확장

전체 경로와 확장자(선택 사항)를 포함하는 파일 또는 폴더 이름으로, 문자형 벡터나 string형 스칼라로 지정됩니다. MATLAB이 생성하는 파일의 이름을 파악하려면 Filename 속성을 확인하십시오.

filename이 기존 폴더 내의 파일을 지정하는 경우, MATLAB은 다음을 수행합니다.

  • fopen(filename,permission,...)을 사용하여 파일을 엽니다.

  • permission이 지정되지 않은 경우, fopen(filename,'w+')를 사용하여 파일을 엽니다.

  • filename이 확장자를 포함하지 않는 경우, MATLAB은 수신된 메시지의 Content-Type 및/또는 Content-Disposition 헤더 필드나 요청의 URI 내 파일 이름의 확장자가 있는 경우 이에 따라 확장자를 추가합니다.

filename이 기존의 쓰기 가능한 폴더를 지정하는 경우, MATLAB은 응답이나 URI의 Content-Disposition 헤더 필드로부터 파생된 이름을 갖는 파일을 폴더에 생성하며, 이 이름이 확장자를 포함하지 않으면 Content-Type에 따라 확장자를 추가합니다.

filename이 누락되었거나 비어 있으면 MATLAB은 현재 폴더에 파일을 생성합니다. 이는 filename = '.'과 동일합니다. 현재 폴더는 send 요청에서 이 FileConsumer가 사용되는 시점이 아닌 이 소비자가 생성된 시점의 폴더를 말합니다.

예: 'myTextFile.txt'

데이터형: char | string

파일 액세스 유형으로, string형으로 지정됩니다. permission이 지정되어 있는 경우, 쓰기 액세스를 허용해야 합니다. 디폴트 값은 'w+'로, 이 권한은 읽기와 쓰기를 위해 파일을 열거나 생성하고, 기존 내용이 있는 경우 모두 삭제합니다.

permission은 fopen 함수가 허용하는 모든 값이 될 수 있습니다. 추가로 다음과 같은 permission 값이 지원됩니다.

'u+', 'u'

'w' 및 'w+'와 동일하나 해당 파일이 존재하는 경우 filename 인수로부터 파생된 고유한 이름을 갖는 파일이 생성됩니다. 새 파일은 확장자를 제외한 이름 부분에 하이픈과 시퀀스 번호가 추가된 이름을 갖습니다.

예를 들어, filename이 'MyFile.txt'인데 이 파일이 존재하는 경우, MATLAB은 MyFile-1.txt라는 파일을 생성합니다. Filename 속성은 새 파일의 전체 경로 이름을 포함합니다.

'T'

권한에 추가된 경우, 텍스트 모드 't'와 유사하게 동작하되 데이터의 Content-Type을 통해 이것이 문자 기반 데이터임을 알 수 있는 경우에만 텍스트 모드를 사용합니다. 문자 기반 유형에는 문자 집합 파라미터를 지정하는 유형이나 "application/json"과 같이 MATLAB이 문자 기반임을 알고 있는 유형이 포함됩니다.

모든 경우를 통틀어, 'w' 권한이나 'w+' 권한이 지정된 경우(또는 permission이 지정되지 않은 경우), MATLAB은 파일 이름이 filename과 완전히 일치하지 않으면 기존 파일을 덮어쓰지 않습니다.

예: 'a''w+T'

데이터형: char | string

바이트 또는 비트를 읽거나 쓰는 순서로, fopen 함수가 허용하는 모든 값으로 지정됩니다.

데이터형: char | string

문자 인코딩으로, fopen 함수가 허용하는 모든 값으로 지정됩니다.

데이터형: char | string

속성

모두 확장

퍼블릭 속성

쓰여지는 파일의 식별자(FID)로, double형으로 지정됩니다. 소비자가 FID 인수와 함께 생성된 경우, 이 속성이 식별자가 됩니다. 데이터는 이 식별자가 가리키는 현재 파일 위치 표시자에 쓰이므로, 이 식별자를 사용할 때 서브클래스가 해당 위치를 실수로 변경하지 않도록 주의해야 합니다. 전송이 완료되면 파일은 열린 상태로 유지되고 위치는 파일의 끝으로 유지됩니다.

생성자가 filename 인수와 함께 또는 인수 없이 호출된 경우, 이 속성은 해당 파일의 읽기 전용 파일 식별자가 됩니다. 따라서 서브클래스는 쓰기에 사용되는 위치 표시자에 영향을 미치지 않고 전송 중에 파일을 읽을 수 있습니다. 전송이 완료되면 이 식별자는 닫힙니다.

특성:

GetAccess
public
SetAccess
private

쓰여지는 파일의 전체 경로 이름으로, string형으로 지정됩니다. 소비자가 FID 인수와 함께 생성된 경우, 이 속성은 파일의 이름이 됩니다. 그렇지 않으면 이 값은 MATLAB이 응답 메시지를 수신 중에 파일에 쓰기를 시작할 때까지 설정되지 않을 수 있습니다. 헤더가 모두 수신되어야만 파일 이름을 확인할 수 있기 때문입니다. 쓰여진 파일을 확인하려면 이 속성을 사용하십시오. Filename은 Response.Body.Data 속성에도 저장됩니다.

특성:

GetAccess
public
SetAccess
private

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

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

특성:

GetAccess
public
SetAccess
public

페이로드의 예상 길이로, 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

페이로드의 미디어 형식으로, 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

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

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

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

특성:

GetAccess
public
SetAccess
public

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

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

특성:

GetAccess
public
SetAccess
public

처리되고 있는 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

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

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

특성:

GetAccess
public
SetAccess
public

보호 속성

함수로, 데이터를 더 추가하기 위해 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

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

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

특성:

GetAccess
protected
SetAccess
protected

현재 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

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

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

특성:

GetAccess
protected
SetAccess
protected

메서드

모두 확장

세부 정보

모두 확장

버전 내역

R2018a에 개발됨

참고 항목

| | | | |