Class Mechanism

java.lang.Object

zmq.io.mechanism.Mechanism

Direct Known Subclasses:

CurveClientMechanism, CurveServerMechanism, GssapiClientMechanism, GssapiServerMechanism, NullMechanism, PlainClientMechanism, PlainServerMechanism

public abstract class Mechanism
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Mechanism.Status

Field Summary

Fields

Modifier and Type	Field	Description
private Blob	identity
protected final Options	options
private final Address	peerAddress
protected final SessionBase	session
protected String	statusCode
private Blob	userId
final Metadata	zapProperties
final Metadata	zmtpProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Mechanism(SessionBase session, Address peerAddress, Options options)

Method Summary

Modifier and Type	Method	Description
protected final void	addProperty(ByteBuffer buf, String name, byte[] value)
protected final void	addProperty(ByteBuffer buf, String name, String value)
protected final void	addProperty(Msg msg, String name, byte[] value)
protected final void	addProperty(Msg msg, String name, String value)
protected boolean	compare(ByteBuffer a1, byte[] b, int offset, int length)
protected boolean	compare(Msg msg, String data, boolean includeLength)
Msg	decode(Msg msg)
void	destroy()
Msg	encode(Msg msg)
final Blob	getUserId()
protected int	handleErrorReason(String reason)
abstract int	nextHandshakeCommand(Msg msg)
protected int	parseErrorMessage(Msg msg)
protected final int	parseMetadata(ByteBuffer msg, int offset, boolean zapFlag)
protected final int	parseMetadata(Msg msg, int offset, boolean zapFlag)
final Msg	peerIdentity()
abstract int	processHandshakeCommand(Msg msg)
protected int	property(String name, byte[] value)
protected final int	receiveAndProcessZapReply()
protected final void	sendZapRequest(Mechanisms mechanism, boolean more)
private void	setPeerIdentity(byte[] data)
private void	setUserId(byte[] data)
protected final String	socketType()
abstract Mechanism.Status	status()
abstract int	zapMsgAvailable()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

options

protected final Options options

identity

private Blob identity

userId

private Blob userId

zapProperties

public final Metadata zapProperties

zmtpProperties

public final Metadata zmtpProperties

session

protected final SessionBase session

peerAddress

private final Address peerAddress

statusCode

protected String statusCode

Constructor Details

Mechanism

protected Mechanism(SessionBase session,
 Address peerAddress,
 Options options)

Method Details

status

public abstract Mechanism.Status status()

setPeerIdentity

private void setPeerIdentity(byte[] data)

peerIdentity

public final Msg peerIdentity()

setUserId

private void setUserId(byte[] data)

getUserId

public final Blob getUserId()

addProperty

protected final void addProperty(ByteBuffer buf,
 String name,
 String value)

addProperty

protected final void addProperty(Msg msg,
 String name,
 String value)

addProperty

protected final void addProperty(ByteBuffer buf,
 String name,
 byte[] value)

addProperty

protected final void addProperty(Msg msg,
 String name,
 byte[] value)

parseMetadata

protected final int parseMetadata(Msg msg,
 int offset,
 boolean zapFlag)

parseMetadata

protected final int parseMetadata(ByteBuffer msg,
 int offset,
 boolean zapFlag)

property

protected int property(String name,
 byte[] value)

socketType

protected final String socketType()

compare

protected boolean compare(Msg msg,
 String data,
 boolean includeLength)

compare

protected boolean compare(ByteBuffer a1,
 byte[] b,
 int offset,
 int length)

decode

public Msg decode(Msg msg)

encode

public Msg encode(Msg msg)

zapMsgAvailable

public abstract int zapMsgAvailable()

processHandshakeCommand

public abstract int processHandshakeCommand(Msg msg)

nextHandshakeCommand

public abstract int nextHandshakeCommand(Msg msg)

parseErrorMessage

protected int parseErrorMessage(Msg msg)

handleErrorReason

protected int handleErrorReason(String reason)

sendZapRequest

protected final void sendZapRequest(Mechanisms mechanism,
 boolean more)

receiveAndProcessZapReply

protected final int receiveAndProcessZapReply()

destroy

public void destroy()