PlcBrowseRequest (PLC4J: API 0.12.0 API)

All Superinterfaces:: PlcMessage, PlcRequest

public interface PlcBrowseRequest
extends PlcRequest

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface PlcBrowseRequest.Builder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CompletableFuture<? extends PlcBrowseResponse>`	`execute()`
`CompletableFuture<? extends PlcBrowseResponse>`	`executeWithInterceptor(PlcBrowseRequestInterceptor interceptor)`	In contrast to the default execute method, the executeWithInterceptor allows passing in a so-called interceptor.
`PlcQuery`	`getQuery(String name)`
`LinkedHashSet<String>`	`getQueryNames()`

- Method Detail
  - execute
```
CompletableFuture<? extends PlcBrowseResponse> execute()
```
    Specified by:
    
    execute in interface PlcRequest
  - executeWithInterceptor
```
CompletableFuture<? extends PlcBrowseResponse> executeWithInterceptor(PlcBrowseRequestInterceptor interceptor)
```
    In contrast to the default execute method, the executeWithInterceptor allows passing in a so-called interceptor. This can be used for two different situations: 1. Filter which items go into the final PlcBrowseResponse (Items are added, if interceptor returns true). 2. Allow accessing found items on the fly while the system is still processing, hereby allowing a more asynchronous consumption of found tags.
    
    Parameters:
    
    interceptor - interceptor for intercepting found items
    
    Returns:
    
    future for the final PlcBrowseResponse
  - getQueryNames
```
LinkedHashSet<String> getQueryNames()
```
  - getQuery
```
PlcQuery getQuery(String name)
```