Protocol

All Implemented Interfaces:

ai.platon.pulsar.common.config.Configurable , ai.platon.pulsar.skeleton.workflow.common.LazyConfigurable , java.lang.AutoCloseable
```
public interface Protocol
 implements LazyConfigurable, AutoCloseable
                    
```
A retriever for url content. Implemented by protocol extensions.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Unit`	`setResponse(Response response)`
`Unit`	`reset()`	Reset the protocol environment, so the peer host view the client as a new one
`Unit`	`cancel(WebPage page)`	Cancel the page
`Unit`	`cancelAll()`	Cancel all fetching tasks
`abstract ProtocolOutput`	`getProtocolOutputDeferred(WebPage page)`	Returns the ProtocolOutput for a fetch list entry.
`abstract BaseRobotRules`	`getRobotRules(WebPage page)`	Retrieve robot rules applicable for this url.
`Unit`	`close()`

Methods inherited from class ai.platon.pulsar.skeleton.workflow.common.LazyConfigurable
configure
Methods inherited from class ai.platon.pulsar.common.config.Configurable
getConf, setConf
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - setResponse
```
 Unit setResponse(Response response)
```
  - reset
```
 Unit reset()
```
    Reset the protocol environment, so the peer host view the client as a new one
  - cancel
```
 Unit cancel(WebPage page)
```
    Cancel the page
  - cancelAll
```
 Unit cancelAll()
```
    Cancel all fetching tasks
  - getProtocolOutputDeferred
```
 abstract ProtocolOutput getProtocolOutputDeferred(WebPage page)
```
    Returns the ProtocolOutput for a fetch list entry.
  - getRobotRules
```
 abstract BaseRobotRules getRobotRules(WebPage page)
```
    Retrieve robot rules applicable for this url.
    
    Parameters:
    
    page - The Web page
    
    Returns:
    
    robot rules (specific for this url or default), never null
  - close
```
 Unit close()
```