AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader Class Reference

A mock AttachmentReader that mocks reading from an empty attachment (immediate EOF). More...

Inheritance diagram for alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader:
Inheritance graph
Collaboration diagram for alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader:
Collaboration graph

Public Member Functions

 MOCK_METHOD1 (seek, bool(uint64_t offset))
 MOCK_CONST_METHOD0 (tell, uint64_t())
 MOCK_METHOD0 (getNumUnreadBytes, uint64_t())
 MOCK_METHOD1 (close, void(ClosePoint closePoint))
size_t read (void *buf, std::size_t numBytes, AttachmentReader::ReadStatus *readStatus, std::chrono::milliseconds timeoutMs)
- Public Member Functions inherited from alexaClientSDK::avsCommon::avs::attachment::AttachmentReader
virtual ~AttachmentReader ()=default
virtual bool seek (uint64_t offset)=0
virtual uint64_t getNumUnreadBytes ()=0
virtual void close (ClosePoint closePoint=ClosePoint::AFTER_DRAINING_CURRENT_BUFFER)=0

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::avs::attachment::AttachmentReader
enum  ReadStatus {
  ReadStatus::OK, ReadStatus::OK_WOULDBLOCK, ReadStatus::OK_TIMEDOUT, ReadStatus::OK_OVERRUN_RESET,
enum  ClosePoint { ClosePoint::IMMEDIATELY, ClosePoint::AFTER_DRAINING_CURRENT_BUFFER }
 An enum class to indicate when the read() function should stop returning data after a call to close(). More...

Detailed Description

A mock AttachmentReader that mocks reading from an empty attachment (immediate EOF).

Member Function Documentation


alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader::MOCK_CONST_METHOD0 ( tell  ,


alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader::MOCK_METHOD0 ( getNumUnreadBytes  ,

◆ MOCK_METHOD1() [1/2]

alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader::MOCK_METHOD1 ( seek  ,
bool(uint64_t offset)   

◆ MOCK_METHOD1() [2/2]

alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader::MOCK_METHOD1 ( close  ,
void(ClosePoint closePoint)   

◆ read()

size_t alexaClientSDK::mediaPlayer::android::test::MockEmptyAttachmentReader::read ( void *  buf,
std::size_t  numBytes,
AttachmentReader::ReadStatus readStatus,
std::chrono::milliseconds  timeoutMs 

The read function.

bufThe buffer where data should be copied to.
numBytesThe size of the buffer in bytes.
[out]readStatusThe out-parameter where the resulting state of the read will be expressed.
timeoutMsThe timeout for this read call in milliseconds. This value is only used for the BLOCKING reader policy. If this parameter is zero, there is no timeout and blocking reads will wait forever.
The number of bytes read as a result of this call.

Implements alexaClientSDK::avsCommon::avs::attachment::AttachmentReader.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0