Maria::HttpMapDataProvider Class Reference

Inheritance diagram for Maria::HttpMapDataProvider:

Public Member Functions
	HttpMapDataProvider (std::shared_ptr< HttpServiceResolver > resolver, const std::string &webInterfaceRoot="mapservice/web", int maxConcurrentRequests=20)
bool	initialize ()
bool	GetMapEntry (const MapContentQuery &mapQuery, Maria::MapEntry &mapEntry, unsigned long timeout) override
std::shared_ptr< MariaProtobuf::FetchMapReplyMessage >	GetTileData (const GenerateMapTileRequest &req, unsigned long timeout_ms) override
void	GetMapEntries (std::vector< MapEntry > &mapEntries) const override
bool	AddRequest (const MapContentQuery &request, FullTileId tileId, std::shared_ptr< ITileDataResponseTarget > responseTarget) override
	Add request to provider. Returns false if provider queue is full.
FullTileId	RemoveRequest (int tileCacheId, bool removeNewest) override
	Try to remove request from queue associated with a specific tile cache.
int	PendingRequestCount (int tileCacheId=-1) const override
	Count of pending requests for specified tile cache.
Public Member Functions inherited from Maria::IMapDataProvider
virtual int	GetFlags ()
virtual bool	GetMapEntry (const MapContentQuery &mapQuery, Maria::MapEntry &mapEntry, unsigned long timeout=0)=0
virtual std::shared_ptr< MariaProtobuf::FetchMapReplyMessage >	GetTileData (const GenerateMapTileRequest &req, unsigned long timeout_ms=0)=0
virtual void	GetMapEntries (std::vector< MapEntry > &mapEntries) const =0
virtual bool	AddRequest (const MapContentQuery &request, FullTileId tileId, std::shared_ptr< ITileDataResponseTarget > responseTarget)=0
	Add request to provider. Returns false if provider queue is full.
virtual FullTileId	RemoveRequest (int tileCacheId, bool removeNewest=false)=0
	Try to remove request from queue associated with a specific tile cache.
virtual int	PendingRequestCount (int tileCacheId=-1) const =0
	Count of pending requests for specified tile cache.
virtual void	GetMapEntries (std::vector< MapEntry > &mapEntries) const =0
	Get all map entries served by the provider. Note that if "*" is set as map signature, the provider can provide data for map signatures of given map type.

Member Function Documentation

AddRequest()

bool HttpMapDataProvider::AddRequest ( const MapContentQuery &  request, FullTileId  tileId, std::shared_ptr< ITileDataResponseTarget >  responseTarget  )

overridevirtual

Add request to provider. Returns false if provider queue is full.

Parameters

request	Tile request
tileId	Tile cache id and tile id of tile
responseTarget	Call to process response from tile providers

Returns

true on success, false if unable to add request

Implements Maria::IMapTileProvider.

GetMapEntries()

void HttpMapDataProvider::GetMapEntries ( std::vector< MapEntry > &  mapEntries ) const

overridevirtual

Get a list of map entries available to this data provider.

Implements Maria::IMapDataProvider.

GetMapEntry()

bool HttpMapDataProvider::GetMapEntry ( const MapContentQuery &  mapQuery, Maria::MapEntry &  mapEntry, unsigned long  timeout  )

overridevirtual

Get a map catalog entry from a map query. This method should fill out the provided mapEntry with the resolved data for the given mapQuery.

The method should return true on success, and false on failure.

The method should block until a response can be given, but at most timeout ms. If timeout = 0, it may block indefinitely.

Implements Maria::IMapDataProvider.

GetTileData()

std::shared_ptr< MariaProtobuf::FetchMapReplyMessage > HttpMapDataProvider::GetTileData ( const GenerateMapTileRequest &  req, unsigned long  timeout_ms  )

overridevirtual

Get map tile data from map query. This method should return a FetchMapReply with tile data or a valid error code for the given mapQuery.

The method should block until a response can be given, but at most timeout ms. If timeout = 0, it may block indefinitely.

Implements Maria::IMapDataProvider.

PendingRequestCount()

int HttpMapDataProvider::PendingRequestCount ( int  tileCacheId = -1 ) const

overridevirtual

Count of pending requests for specified tile cache.

Parameters

tileCacheId

Tile cache id

Returns

Number of pending requests

Implements Maria::IMapTileProvider.

RemoveRequest()

FullTileId HttpMapDataProvider::RemoveRequest ( int  tileCacheId, bool  removeNewest  )

overridevirtual

Try to remove request from queue associated with a specific tile cache.

Parameters

tileCacheId	Tile cache id
removeNewest	If true, remove newest request. Of false, remove oldest request

Returns

Id of removed tile, InvalidTileId on failure

Implements Maria::IMapTileProvider.

---

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

• Native/MariaNative/MMapDataProvider/MHttpMapDataProvider.h
• Native/MariaNative/MMapDataProvider/MHttpMapDataProvider.cpp