processing/java/libraries/net/src/processing/net/Client.java at master · IvanJs/processing · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */

Client - basic network client implementation

Part of the Processing project - http://processing.org

The previous version of this code was developed by Hernando Barragan

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

package processing.net;

import processing.core.*;

import java.io.*;

import java.lang.reflect.*;

import java.net.*;

/**

* ( begin auto-generated from Client.xml )

* A client connects to a server and sends data back and forth. If anything

* goes wrong with the connection, for example the host is not there or is

* listening on a different port, an exception is thrown.

* ( end auto-generated )

* @webref net

* @brief The client class is used to create client Objects which connect to a server to exchange data.

* @instanceName client any variable of type Client

* @usage Application

* @see_external LIB_net/clientEvent

public class Client implements Runnable {

PApplet parent;

Method clientEventMethod;

Method disconnectEventMethod;

Thread thread;

Socket socket;

String ip;

int port;

String host;

public InputStream input;

public OutputStream output;

byte buffer[] = new byte[32768];

int bufferIndex;

int bufferLast;

/**

* @param parent typically use "this"

* @param host address of the server

* @param port port to read/write from on the server

public Client(PApplet parent, String host, int port) {

this.parent = parent;

this.host = host;

this.port = port;

try {

socket = new Socket(this.host, this.port);

input = socket.getInputStream();

output = socket.getOutputStream();

thread = new Thread(this);

thread.start();

parent.registerMethod("dispose", this);

// reflection to check whether host sketch has a call for

// public void clientEvent(processing.net.Client)

// which would be called each time an event comes in

try {

clientEventMethod =

parent.getClass().getMethod("clientEvent",

new Class[] { Client.class });

} catch (Exception e) {

// no such method, or an error.. which is fine, just ignore

}

// do the same for disconnectEvent(Client c);

try {

disconnectEventMethod =

parent.getClass().getMethod("disconnectEvent",

new Class[] { Client.class });

} catch (Exception e) {

// no such method, or an error.. which is fine, just ignore

}

} catch (ConnectException ce) {

ce.printStackTrace();

dispose();

} catch (IOException e) {

e.printStackTrace();

dispose();

}

/**

* @param socket any object of type Socket

* @throws IOException

public Client(PApplet parent, Socket socket) throws IOException {

this.socket = socket;

input = socket.getInputStream();

output = socket.getOutputStream();

thread = new Thread(this);

thread.start();

}

/**

* ( begin auto-generated from Client_stop.xml )

* Disconnects from the server. Use to shut the connection when you're

* finished with the Client.

* ( end auto-generated )

* @webref client:client

* @brief Disconnects from the server

* @usage application

public void stop() {

if (disconnectEventMethod != null) {

try {

disconnectEventMethod.invoke(parent, new Object[] { this });

} catch (Exception e) {

e.printStackTrace();

disconnectEventMethod = null;

}

dispose();

}

/**

* Disconnect from the server: internal use only.

* <P>

* This should only be called by the internal functions in PApplet,

* use stop() instead from within your own applets.

public void dispose() {

thread = null;

try {

if (input != null) {

input.close();

input = null;

}

} catch (Exception e) {

e.printStackTrace();

}

try {

if (output != null) {

output.close();

output = null;

}

} catch (Exception e) {

e.printStackTrace();

}

try {

if (socket != null) {

socket.close();

socket = null;

}

} catch (Exception e) {

e.printStackTrace();

}

public void run() {

while (Thread.currentThread() == thread) {

try {

while (input != null) {

int value;

// try to read a byte using a blocking read.

// An exception will occur when the sketch is exits.

try {

value = input.read();

} catch (SocketException e) {

System.err.println("Client SocketException: " + e.getMessage());

// the socket had a problem reading so don't try to read from it again.

stop();

return;

}

// read returns -1 if end-of-stream occurs (for example if the host disappears)

if (value == -1) {

System.err.println("Client got end-of-stream.");

stop();

return;

}

synchronized (buffer) {

// todo: at some point buffer should stop increasing in size,

// otherwise it could use up all the memory.

if (bufferLast == buffer.length) {

byte temp[] = new byte[bufferLast << 1];

System.arraycopy(buffer, 0, temp, 0, bufferLast);

buffer = temp;

}

buffer[bufferLast++] = (byte)value;

}

// now post an event

if (clientEventMethod != null) {

try {

clientEventMethod.invoke(parent, new Object[] { this });

} catch (Exception e) {

System.err.println("error, disabling clientEvent() for " + host);

e.printStackTrace();

clientEventMethod = null;

}

} catch (IOException e) {

//errorMessage("run", e);

e.printStackTrace();

}

/**

* Return true if this client is still active and hasn't run

* into any trouble.

public boolean active() {

return (thread != null);

}

/**

* ( begin auto-generated from Client_ip.xml )

* Returns the IP address of the computer to which the Client is attached.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Returns the IP address of the machine as a String

public String ip() {

return socket.getInetAddress().getHostAddress();

}

/**

* ( begin auto-generated from Client_available.xml )

* Returns the number of bytes available. When any client has bytes

* available from the server, it returns the number of bytes.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Returns the number of bytes in the buffer waiting to be read

public int available() {

return (bufferLast - bufferIndex);

}

/**

* ( begin auto-generated from Client_clear.xml )

* Empty the buffer, removes all the data stored there.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Clears the buffer

public void clear() {

bufferLast = 0;

bufferIndex = 0;

}

/**

* ( begin auto-generated from Client_read.xml )

* Returns a number between 0 and 255 for the next byte that's waiting in

* the buffer. Returns -1 if there is no byte, although this should be

* avoided by first cheacking <b>available()</b> to see if any data is available.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Returns a value from the buffer

public int read() {

if (bufferIndex == bufferLast) return -1;

synchronized (buffer) {

int outgoing = buffer[bufferIndex++] & 0xff;

if (bufferIndex == bufferLast) { // rewind

bufferIndex = 0;

bufferLast = 0;

}

return outgoing;

}

/**

* ( begin auto-generated from Client_readChar.xml )

* Returns the next byte in the buffer as a char. Returns -1 or 0xffff if

* nothing is there.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Returns the next byte in the buffer as a char

public char readChar() {

if (bufferIndex == bufferLast) return (char)(-1);

return (char) read();

}

/**

* ( begin auto-generated from Client_readBytes.xml )

* Reads a group of bytes from the buffer. The version with no parameters

* returns a byte array of all data in the buffer. This is not efficient,

* but is easy to use. The version with the <b>byteBuffer</b> parameter is

* more memory and time efficient. It grabs the data in the buffer and puts

* it into the byte array passed in and returns an int value for the number

* of bytes read. If more bytes are available than can fit into the

* <b>byteBuffer</b>, only those that fit are read.

* ( end auto-generated )

* <h3>Advanced</h3>

* Return a byte array of anything that's in the serial buffer.

* Not particularly memory/speed efficient, because it creates

* a byte array on each read, but it's easier to use than

* readBytes(byte b[]) (see below).

* @webref client:client

* @usage application

* @brief Reads everything in the buffer

public byte[] readBytes() {

if (bufferIndex == bufferLast) return null;

synchronized (buffer) {

int length = bufferLast - bufferIndex;

byte outgoing[] = new byte[length];

System.arraycopy(buffer, bufferIndex, outgoing, 0, length);

bufferIndex = 0; // rewind

bufferLast = 0;

return outgoing;

}

/**

* <h3>Advanced</h3>

* Grab whatever is in the serial buffer, and stuff it into a

* byte buffer passed in by the user. This is more memory/time

* efficient than readBytes() returning a byte[] array.

* Returns an int for how many bytes were read. If more bytes

* are available than can fit into the byte array, only those

* that will fit are read.

* @param bytebuffer passed in byte array to be altered

public int readBytes(byte bytebuffer[]) {

if (bufferIndex == bufferLast) return 0;

synchronized (buffer) {

int length = bufferLast - bufferIndex;

if (length > bytebuffer.length) length = bytebuffer.length;

System.arraycopy(buffer, bufferIndex, bytebuffer, 0, length);

bufferIndex += length;

if (bufferIndex == bufferLast) {

bufferIndex = 0; // rewind

bufferLast = 0;

}

return length;

}

/**

* ( begin auto-generated from Client_readBytesUntil.xml )

* Reads from the port into a buffer of bytes up to and including a

* particular character. If the character isn't in the buffer, 'null' is

* returned. The version with no <b>byteBuffer</b> parameter returns a byte

* array of all data up to and including the <b>interesting</b> byte. This

* is not efficient, but is easy to use. The version with the

* <b>byteBuffer</b> parameter is more memory and time efficient. It grabs

* the data in the buffer and puts it into the byte array passed in and

* returns an int value for the number of bytes read. If the byte buffer is

* not large enough, -1 is returned and an error is printed to the message

* area. If nothing is in the buffer, 0 is returned.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Reads from the buffer of bytes up to and including a particular character

* @param interesting character designated to mark the end of the data

public byte[] readBytesUntil(int interesting) {

if (bufferIndex == bufferLast) return null;

byte what = (byte)interesting;

synchronized (buffer) {

int found = -1;

for (int k = bufferIndex; k < bufferLast; k++) {

if (buffer[k] == what) {

found = k;

break;

}

if (found == -1) return null;

int length = found - bufferIndex + 1;

byte outgoing[] = new byte[length];

System.arraycopy(buffer, bufferIndex, outgoing, 0, length);

bufferIndex += length;

if (bufferIndex == bufferLast) {

bufferIndex = 0; // rewind

bufferLast = 0;

}

return outgoing;

}

/**

* <h3>Advanced</h3>

* Reads from the serial port into a buffer of bytes until a

* particular character. If the character isn't in the serial

* buffer, then 'null' is returned.

* If outgoing[] is not big enough, then -1 is returned,

* and an error message is printed on the console.

* If nothing is in the buffer, zero is returned.

* If 'interesting' byte is not in the buffer, then 0 is returned.

* @param byteBuffer passed in byte array to be altered

public int readBytesUntil(int interesting, byte byteBuffer[]) {

if (bufferIndex == bufferLast) return 0;

byte what = (byte)interesting;

synchronized (buffer) {

int found = -1;

for (int k = bufferIndex; k < bufferLast; k++) {

if (buffer[k] == what) {

found = k;

break;

}

if (found == -1) return 0;

int length = found - bufferIndex + 1;

if (length > byteBuffer.length) {

System.err.println("readBytesUntil() byte buffer is" +

" too small for the " + length +

" bytes up to and including char " + interesting);

return -1;

}

//byte outgoing[] = new byte[length];

System.arraycopy(buffer, bufferIndex, byteBuffer, 0, length);

bufferIndex += length;

if (bufferIndex == bufferLast) {

bufferIndex = 0; // rewind

bufferLast = 0;

}

return length;

}

/**

* ( begin auto-generated from Client_readString.xml )

* Returns the all the data from the buffer as a String. This method

* assumes the incoming characters are ASCII. If you want to transfer

* Unicode data, first convert the String to a byte stream in the

* representation of your choice (i.e. UTF8 or two-byte Unicode data), and

* send it as a byte array.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Returns the buffer as a String

public String readString() {

if (bufferIndex == bufferLast) return null;

return new String(readBytes());

}

/**

* ( begin auto-generated from Client_readStringUntil.xml )

* Combination of <b>readBytesUntil()</b> and <b>readString()</b>. Returns

* <b>null</b> if it doesn't find what you're looking for.

* ( end auto-generated )

* <h3>Advanced</h3>

* <p/>

* If you want to move Unicode data, you can first convert the

* String to a byte stream in the representation of your choice

* (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.

* @webref client:client

* @usage application

* @brief Returns the buffer as a String up to and including a particular character

* @param interesting character designated to mark the end of the data

public String readStringUntil(int interesting) {

byte b[] = readBytesUntil(interesting);

if (b == null) return null;

return new String(b);

}

/**

* ( begin auto-generated from Client_write.xml )

* Writes data to a server specified when constructing the client.

* ( end auto-generated )

* @webref client:client

* @usage application

* @brief Writes bytes, chars, ints, bytes[], Strings

* @param data data to write

public void write(int data) { // will also cover char

try {

output.write(data & 0xff); // for good measure do the &

output.flush(); // hmm, not sure if a good idea

} catch (Exception e) { // null pointer or serial port dead

//errorMessage("write", e);

//e.printStackTrace();

//dispose();

//disconnect(e);

e.printStackTrace();

stop();

}

public void write(byte data[]) {

try {

output.write(data);

output.flush(); // hmm, not sure if a good idea

} catch (Exception e) { // null pointer or serial port dead

//errorMessage("write", e);

//e.printStackTrace();

//disconnect(e);

e.printStackTrace();

stop();

}

/**

* <h3>Advanced</h3>

* Write a String to the output. Note that this doesn't account

* for Unicode (two bytes per char), nor will it send UTF8

* characters.. It assumes that you mean to send a byte buffer

* (most often the case for networking and serial i/o) and

* will only use the bottom 8 bits of each char in the string.

* (Meaning that internally it uses String.getBytes)

* If you want to move Unicode data, you can first convert the

* String to a byte stream in the representation of your choice

* (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.

public void write(String data) {

write(data.getBytes());

}

/**

* Handle disconnect due to an Exception being thrown.

protected void disconnect(Exception e) {

dispose();

if (e != null) {

e.printStackTrace();

}

/**

* General error reporting, all corralled here just in case

* I think of something slightly more intelligent to do.

//public void errorMessage(String where, Exception e) {

//parent.die("Error inside Client." + where + "()", e);

//e.printStackTrace(System.err);

//}

}

processing/java/libraries/net/src/processing/net/Client.java at master · IvanJs/processing · GitHub

Repository navigation

Expand file tree

Breadcrumbs

Client.java

Latest commit

History

Breadcrumbs

Client.java

File metadata and controls