Index

Modules: curly.

API symbols

`[]`:

• curly: proc `[]`(batch: RequestBatch; i: int): lent BatchedRequest

addRequest:

• curly: proc addRequest(batch: var RequestBatch; verb: sink string; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: sink string = ""; tag: sink string = "")

BatchedRequest:

• curly: object BatchedRequest

borrow:

• curly: proc borrow(pool: CurlPool): PCurl

clearQueue:

• curly: proc clearQueue(curl: Curly)

close:

• curly: proc close(pool: CurlPool)
• curly: proc close(curl: Curly)
• curly: proc close(stream: ResponseStream)

CurlPool:

• curly: type CurlPool

Curly:

• curly: type Curly

CurlyObj:

• curly: object CurlyObj

delete:

• curly: proc delete(pool: CurlPool; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc delete(curl: Curly; url: string; headers: sink HttpHeaders = emptyHttpHeaders(); timeout = 60): Response
• curly: proc delete(curl: PCurl; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc delete(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); tag: sink string = "")

get:

• curly: proc get(pool: CurlPool; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc get(curl: Curly; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); timeout = 60): Response
• curly: proc get(curl: PCurl; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc get(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); tag: sink string = "")

hasRequests:

• curly: proc hasRequests(curl: Curly): bool

head:

• curly: proc head(pool: CurlPool; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc head(curl: Curly; url: string; headers: sink HttpHeaders = emptyHttpHeaders(); timeout = 60): Response
• curly: proc head(curl: PCurl; url: string; headers = emptyHttpHeaders(); timeout: float32 = 60.0): Response
• curly: proc head(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); tag: sink string = "")

len:

• curly: proc len(batch: RequestBatch): int

makeRequest:

• curly: proc makeRequest(curl: Curly; verb: sink string; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout = 60): Response
• curly: proc makeRequest(curl: PCurl; verb: string; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response

makeRequests:

• curly: proc makeRequests(curl: Curly; batch: RequestBatch; timeout = 60): ResponseBatch

newCurlPool:

• curly: proc newCurlPool(size: int): CurlPool

newCurly:

• curly: proc newCurly(maxInFlight = 16): Curly

numInFlight:

• curly: proc numInFlight(curl: Curly): int

patch:

• curly: proc patch(pool: CurlPool; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc patch(curl: Curly; url: string; headers: sink HttpHeaders = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout = 60): Response
• curly: proc patch(curl: PCurl; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc patch(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: sink string = ""; tag: sink string = "")

pollForResponse:

• curly: proc pollForResponse(curl: Curly): Option[RequestResult]

post:

• curly: proc post(pool: CurlPool; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc post(curl: Curly; url: string; headers: sink HttpHeaders = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout = 60): Response
• curly: proc post(curl: PCurl; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc post(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: sink string = ""; tag: sink string = "")

put:

• curly: proc put(pool: CurlPool; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc put(curl: Curly; url: string; headers: sink HttpHeaders = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout = 60): Response
• curly: proc put(curl: PCurl; url: string; headers = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout: float32 = 60.0): Response
• curly: proc put(batch: var RequestBatch; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: sink string = ""; tag: sink string = "")

queueLen:

• curly: proc queueLen(curl: Curly): int

read:

• curly: proc read(stream: ResponseStream; buffer: var string): int

recycle:

• curly: proc recycle(pool: CurlPool; handle: PCurl)

request:

• curly: proc request(curl: Curly; verb: sink string; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: openArray[char] = "".toOpenArray(0, -1); timeout = 60): ResponseStream

RequestBatch:

• curly: object RequestBatch

RequestInfo:

• curly: object RequestInfo

Response:

• curly: object Response

ResponseBatch:

• curly: type ResponseBatch

ResponseStream:

• curly: object ResponseStream

startRequest:

• curly: proc startRequest(curl: Curly; verb: sink string; url: sink string; headers: sink HttpHeaders = emptyHttpHeaders(); body: sink string = ""; timeout = 60; tag: sink string = "")

startRequests:

• curly: proc startRequests(curl: Curly; batch: sink RequestBatch; timeout = 60)

waitForResponse:

• curly: proc waitForResponse(curl: Curly): tuple[response: Response, error: string]

withHandle:

• curly: template withHandle(pool: CurlPool; handle, body)