Pipe

java.lang.Object
- zmq.ZObject
- - zmq.Pipe

```
class Pipe
extends ZObject
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static interface Pipe.IPipeEvents

(package private) static class Pipe.State

Nested Classes
Modifier and Type	Class and Description
`(package private) static interface`	`Pipe.IPipeEvents`
`(package private) static class`	`Pipe.State`

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`delay`
`private int`	`hwm`
`private Blob`	`identity`
`private boolean`	`inActive`
`private YPipe<Msg>`	`inpipe`
`private int`	`lwm`
`private long`	`msgsRead`
`private long`	`msgsWritten`
`private boolean`	`outActive`
`private YPipe<Msg>`	`outpipe`
`private ZObject`	`parent`
`private Pipe`	`peer`
`private long`	`peersMsgsRead`
`private Pipe.IPipeEvents`	`sink`
`private Pipe.State`	`state`

Constructor Summary

Constructors
Modifier Constructor and Description

private Pipe(ZObject parent, YPipe<Msg> inpipe, YPipe<Msg> outpipe, int inhwm, int outhwm, boolean delay)

Constructors
Modifier	Constructor and Description
`private`	`Pipe(ZObject parent, YPipe<Msg> inpipe, YPipe<Msg> outpipe, int inhwm, int outhwm, boolean delay)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkHwm()`
`boolean`	`checkRead()`
`boolean`	`checkWrite()`
`private static int`	`computeLwm(int hwm)`
`private void`	`delimit()`
`void`	`flush()`
`Blob`	`getIdentity()`
`void`	`hiccup()`
`private static boolean`	`isDelimiter(Msg msg)`
`static void`	`pipepair(ZObject[] parents, Pipe[] pipes, int[] hwms, boolean[] delays)`
`protected void`	`processActivateRead()`
`protected void`	`processActivateWrite(long msgsRead)`
`protected void`	`processHiccup(java.lang.Object pipe)`
`protected void`	`processPipeTerm()`
`protected void`	`processPipeTermAck()`
`Msg`	`read()`
`void`	`rollback()`
`void`	`setEventSink(Pipe.IPipeEvents sink)`
`void`	`setIdentity(Blob identity)`
`private void`	`setPeer(Pipe peer)`
`void`	`terminate(boolean delay)`
`java.lang.String`	`toString()`
`boolean`	`write(Msg msg)`

Methods inherited from class zmq.ZObject
chooseIoThread, destroySocket, findEndpoint, getCtx, getTid, processAttach, processBind, processCommand, processOwn, processPlug, processReap, processReaped, processSeqnum, processStop, processTerm, processTermAck, processTermReq, registerEndpoint, sendActivateRead, sendActivateWrite, sendAttach, sendAttach, sendBind, sendBind, sendDone, sendHiccup, sendOwn, sendPipeTerm, sendPipeTermAck, sendPlug, sendPlug, sendReap, sendReaped, sendStop, sendTerm, sendTermAck, sendTermReq, unregisterEndpoints

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

inpipe
```
private YPipe<Msg> inpipe
```

outpipe
```
private YPipe<Msg> outpipe
```

inActive
```
private boolean inActive
```

outActive
```
private boolean outActive
```

hwm
```
private int hwm
```

lwm
```
private int lwm
```

msgsRead
```
private long msgsRead
```

msgsWritten
```
private long msgsWritten
```

peersMsgsRead
```
private long peersMsgsRead
```

peer
```
private Pipe peer
```

sink
```
private Pipe.IPipeEvents sink
```

state
```
private Pipe.State state
```

delay
```
private boolean delay
```

identity
```
private Blob identity
```

parent
```
private ZObject parent
```

Constructor Detail

Pipe

private Pipe(ZObject parent,
             YPipe<Msg> inpipe,
             YPipe<Msg> outpipe,
             int inhwm,
             int outhwm,
             boolean delay)

Method Detail

pipepair

public static void pipepair(ZObject[] parents,
                            Pipe[] pipes,
                            int[] hwms,
                            boolean[] delays)

setPeer
```
private void setPeer(Pipe peer)
```

setEventSink

public void setEventSink(Pipe.IPipeEvents sink)

setIdentity

public void setIdentity(Blob identity)

getIdentity
```
public Blob getIdentity()
```

checkRead
```
public boolean checkRead()
```

read
```
public Msg read()
```

checkWrite
```
public boolean checkWrite()
```

write
```
public boolean write(Msg msg)
```

rollback
```
public void rollback()
```

flush
```
public void flush()
```

processActivateRead
```
protected void processActivateRead()
```
Overrides:

processActivateRead in class ZObject

processActivateWrite
```
protected void processActivateWrite(long msgsRead)
```
Overrides:

processActivateWrite in class ZObject

processHiccup

protected void processHiccup(java.lang.Object pipe)

Overrides:: processHiccup in class ZObject

processPipeTerm
```
protected void processPipeTerm()
```
Overrides:

processPipeTerm in class ZObject

processPipeTermAck
```
protected void processPipeTermAck()
```
Overrides:

processPipeTermAck in class ZObject

terminate
```
public void terminate(boolean delay)
```

isDelimiter

private static boolean isDelimiter(Msg msg)

computeLwm

private static int computeLwm(int hwm)

delimit
```
private void delimit()
```

hiccup
```
public void hiccup()
```

checkHwm
```
public boolean checkHwm()
```

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class Pipe

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class zmq.ZObject

Methods inherited from class java.lang.Object

Field Detail

inpipe

outpipe

inActive

outActive

hwm

lwm

msgsRead

msgsWritten

peersMsgsRead

peer

sink

state

delay

identity

parent

Constructor Detail

Pipe

Method Detail

pipepair

setPeer

setEventSink

setIdentity

getIdentity

checkRead

read

checkWrite

write

rollback

flush

processActivateRead

processActivateWrite

processHiccup

processPipeTerm

processPipeTermAck

terminate

isDelimiter

computeLwm

delimit

hiccup

checkHwm

toString